1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?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( 'extension', 'Perform default conversion on an extension',
false, true );
$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.", 1 );
}
$phpfile = "$IP/extensions/$extension/$extension.i18n.php";
}
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", 1 );
}
include $phpfile;
$phpfileContents = file_get_contents( $phpfile );
if ( !isset( $messages ) ) {
$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 );
}
if ( !isset( $messages['en'] ) || !is_array( $messages['en'] ) ) {
$this->error( "PHP file $phpfile does not set language codes", 1 );
}
foreach ( $messages as $langcode => $langmsgs ) {
$authors = $this->getAuthorsFromComment( $this->findCommentBefore(
"\$messages['$langcode'] =",
$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" );
}
$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"
);
}
/**
* 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;
|
