MediaWiki REL1_30
generateJsonI18n.php
Go to the documentation of this file.
1<?php
2
28require_once __DIR__ . '/Maintenance.php';
29
36 public function __construct() {
37 parent::__construct();
38 $this->addDescription( 'Build JSON messages files from a PHP messages file' );
39
40 $this->addArg( 'phpfile', 'PHP file defining a $messages array', false );
41 $this->addArg( 'jsondir', 'Directory to write JSON files to', false );
42 $this->addOption( 'extension', 'Perform default conversion on an extension',
43 false, true );
44 $this->addOption( 'supplementary', 'Find supplementary i18n files in subdirs and convert those',
45 false, false );
46 }
47
48 public function execute() {
49 global $IP;
50
51 $phpfile = $this->getArg( 0 );
52 $jsondir = $this->getArg( 1 );
53 $extension = $this->getOption( 'extension' );
54 $convertSupplementaryI18nFiles = $this->hasOption( 'supplementary' );
55
56 if ( $extension ) {
57 if ( $phpfile ) {
58 $this->error( "The phpfile is already specified, conflicts with --extension.", 1 );
59 }
60 $phpfile = "$IP/extensions/$extension/$extension.i18n.php";
61 }
62
63 if ( !$phpfile ) {
64 $this->error( "I'm here for an argument!" );
65 $this->maybeHelp( true );
66 // dies.
67 }
68
69 if ( $convertSupplementaryI18nFiles ) {
70 if ( is_readable( $phpfile ) ) {
71 $this->transformI18nFile( $phpfile, $jsondir );
72 } else {
73 // This is non-fatal because we might want to continue searching for
74 // i18n files in subdirs even if the extension does not include a
75 // primary i18n.php.
76 $this->error( "Warning: no primary i18n file was found." );
77 }
78 $this->output( "Searching for supplementary i18n files...\n" );
79 $dir_iterator = new RecursiveDirectoryIterator( dirname( $phpfile ) );
80 $iterator = new RecursiveIteratorIterator(
81 $dir_iterator, RecursiveIteratorIterator::LEAVES_ONLY );
82 foreach ( $iterator as $path => $fileObject ) {
83 if ( fnmatch( "*.i18n.php", $fileObject->getFilename() ) ) {
84 $this->output( "Converting $path.\n" );
85 $this->transformI18nFile( $path );
86 }
87 }
88 } else {
89 // Just convert the primary i18n file.
90 $this->transformI18nFile( $phpfile, $jsondir );
91 }
92 }
93
94 public function transformI18nFile( $phpfile, $jsondir = null ) {
95 if ( !$jsondir ) {
96 // Assume the json directory should be in the same directory as the
97 // .i18n.php file.
98 $jsondir = dirname( $phpfile ) . "/i18n";
99 }
100 if ( !is_dir( $jsondir ) ) {
101 $this->output( "Creating directory $jsondir.\n" );
102 $success = mkdir( $jsondir );
103 if ( !$success ) {
104 $this->error( "Could not create directory $jsondir", 1 );
105 }
106 }
107
108 if ( !is_readable( $phpfile ) ) {
109 $this->error( "Error reading $phpfile", 1 );
110 }
111 $messages = null;
112 include $phpfile;
113 $phpfileContents = file_get_contents( $phpfile );
114
115 if ( !isset( $messages ) ) {
116 $this->error( "PHP file $phpfile does not define \$messages array", 1 );
117 }
118
119 if ( !$messages ) {
120 $this->error( "PHP file $phpfile contains an empty \$messages array. " .
121 "Maybe it was already converted?", 1 );
122 }
123
124 if ( !isset( $messages['en'] ) || !is_array( $messages['en'] ) ) {
125 $this->error( "PHP file $phpfile does not set language codes", 1 );
126 }
127
128 foreach ( $messages as $langcode => $langmsgs ) {
129 $authors = $this->getAuthorsFromComment( $this->findCommentBefore(
130 "\$messages['$langcode'] =",
131 $phpfileContents
132 ) );
133 // Make sure the @metadata key is the first key in the output
134 $langmsgs = array_merge(
135 [ '@metadata' => [ 'authors' => $authors ] ],
136 $langmsgs
137 );
138
139 $jsonfile = "$jsondir/$langcode.json";
140 $success = file_put_contents(
141 $jsonfile,
142 FormatJson::encode( $langmsgs, "\t", FormatJson::ALL_OK ) . "\n"
143 );
144 if ( $success === false ) {
145 $this->error( "FAILED to write $jsonfile", 1 );
146 }
147 $this->output( "$jsonfile\n" );
148 }
149
150 $this->output(
151 "All done. To complete the conversion, please do the following:\n" .
152 "* Add \$wgMessagesDirs['YourExtension'] = __DIR__ . '/i18n';\n" .
153 "* Remove \$wgExtensionMessagesFiles['YourExtension']\n" .
154 "* Delete the old PHP message file\n" .
155 "This script no longer generates backward compatibility shims! If you need\n" .
156 "compatibility with MediaWiki 1.22 and older, use the MediaWiki 1.23 version\n" .
157 "of this script instead, or create a shim manually.\n"
158 );
159 }
160
167 protected function findCommentBefore( $needle, $haystack ) {
168 $needlePos = strpos( $haystack, $needle );
169 if ( $needlePos === false ) {
170 return '';
171 }
172 // Need to pass a negative offset to strrpos() so it'll search backwards from the
173 // offset
174 $startPos = strrpos( $haystack, '
187 protected function getAuthorsFromComment( $comment ) {
188 $matches = null;
189 preg_match_all( '/@author (.*?)$/m', $comment, $matches );
190
191 return $matches && $matches[1] ? $matches[1] : [];
192 }
193}
194
195$maintClass = "GenerateJsonI18n";
196require_once RUN_MAINTENANCE_IF_MAIN;
$messages
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)
Add some args that are needed.
hasOption( $name)
Checks to see if a particular param exists.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
maybeHelp( $force=false)
Maybe show the help.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2581
$IP
Definition update.php:3