MediaWiki  REL1_31
generateJsonI18n.php
Go to the documentation of this file.
1 <?php
2 
28 require_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->fatalError( "The phpfile is already specified, conflicts with --extension." );
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->fatalError( "Could not create directory $jsondir" );
105  }
106  }
107 
108  if ( !is_readable( $phpfile ) ) {
109  $this->fatalError( "Error reading $phpfile" );
110  }
111  $messages = null;
112  include $phpfile;
113  $phpfileContents = file_get_contents( $phpfile );
114 
115  if ( !isset( $messages ) ) {
116  $this->fatalError( "PHP file $phpfile does not define \$messages array" );
117  }
118 
119  if ( !$messages ) {
120  $this->fatalError( "PHP file $phpfile contains an empty \$messages array. " .
121  "Maybe it was already converted?" );
122  }
123 
124  if ( !isset( $messages['en'] ) || !is_array( $messages['en'] ) ) {
125  $this->fatalError( "PHP file $phpfile does not set language codes" );
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->fatalError( "FAILED to write $jsonfile" );
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::class;
196 require_once RUN_MAINTENANCE_IF_MAIN;
GenerateJsonI18n\__construct
__construct()
Default constructor.
Definition: generateJsonI18n.php:36
Maintenance\maybeHelp
maybeHelp( $force=false)
Maybe show the help.
Definition: Maintenance.php:999
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$success
$success
Definition: NoLocalSettings.php:42
FormatJson\ALL_OK
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
GenerateJsonI18n\execute
execute()
Do the actual work.
Definition: generateJsonI18n.php:48
GenerateJsonI18n\getAuthorsFromComment
getAuthorsFromComment( $comment)
Get an array of author names from a documentation comment containing.
Definition: generateJsonI18n.php:187
GenerateJsonI18n
Maintenance script to generate JSON i18n files from a PHP i18n file.
Definition: generateJsonI18n.php:35
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
GenerateJsonI18n\findCommentBefore
findCommentBefore( $needle, $haystack)
Find the documentation comment immediately before a given search string.
Definition: generateJsonI18n.php:167
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
GenerateJsonI18n\transformI18nFile
transformI18nFile( $phpfile, $jsondir=null)
Definition: generateJsonI18n.php:94
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:271
$path
$path
Definition: NoLocalSettings.php:25
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:416
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:310
$IP
$IP
Definition: WebStart.php:52
$messages
$messages
Definition: LogTests.i18n.php:8