3 * Merge $wgExtensionMessagesFiles from various extensions to produce a
4 * single array containing all message files.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup Maintenance
26 define( 'MW_NO_EXTENSION_MESSAGES', 1 );
28 require_once __DIR__
. '/Maintenance.php';
29 $maintClass = 'MergeMessageFileList';
33 * Maintenance script that merges $wgExtensionMessagesFiles from various
34 * extensions to produce a single array containing all message files.
36 * @ingroup Maintenance
38 class MergeMessageFileList
extends Maintenance
{
44 function __construct() {
45 parent
::__construct();
48 'A file containing a list of extension setup files, one per line.',
52 $this->addOption( 'extensions-dir', 'Path where extensions can be found.', false, true );
53 $this->addOption( 'output', 'Send output to this file (omit for stdout)', false, true );
54 $this->addDescription( 'Merge $wgExtensionMessagesFiles and $wgMessagesDirs from ' .
55 ' various extensions to produce a single file listing all message files and dirs.'
59 public function execute() {
60 // @codingStandardsIgnoreStart Ignore error: Global variable "$mmfl" is lacking 'wg' prefix
62 // @codingStandardsIgnoreEnd
63 global $wgExtensionEntryPointListFiles;
65 if ( !count( $wgExtensionEntryPointListFiles )
66 && !$this->hasOption( 'list-file' )
67 && !$this->hasOption( 'extensions-dir' )
69 $this->error( "Either --list-file or --extensions-dir must be provided if " .
70 "\$wgExtensionEntryPointListFiles is not set", 1 );
73 $mmfl = [ 'setupFiles' => [] ];
75 # Add setup files contained in file passed to --list-file
76 if ( $this->hasOption( 'list-file' ) ) {
77 $extensionPaths = $this->readFile( $this->getOption( 'list-file' ) );
78 $mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
81 # Now find out files in a directory
82 if ( $this->hasOption( 'extensions-dir' ) ) {
83 $extdir = $this->getOption( 'extensions-dir' );
84 # Allow multiple directories to be passed with ":" as delimiter
85 $extdirs = explode( ':', $extdir );
87 foreach ( $extdirs as $extdir ) {
88 $entries = array_merge( $entries, scandir( $extdir ) );
90 foreach ( $entries as $extname ) {
91 if ( $extname == '.' ||
$extname == '..' ||
!is_dir( "$extdir/$extname" ) ) {
95 "$extdir/$extname/extension.json",
96 "$extdir/$extname/skin.json",
97 "$extdir/$extname/$extname.php"
100 foreach ( $possibilities as $extfile ) {
101 if ( file_exists( $extfile ) ) {
102 $mmfl['setupFiles'][] = $extfile;
109 $this->hasError
= true;
110 $this->error( "Extension {$extname} in {$extdir} lacks expected entry point: " .
111 "extension.json, skin.json, or {$extname}.php." );
116 # Add setup files defined via configuration
117 foreach ( $wgExtensionEntryPointListFiles as $points ) {
118 $extensionPaths = $this->readFile( $points );
119 $mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
122 if ( $this->hasError
) {
123 $this->error( "Some files are missing (see above). Giving up.", 1 );
126 if ( $this->hasOption( 'output' ) ) {
127 $mmfl['output'] = $this->getOption( 'output' );
129 if ( $this->hasOption( 'quiet' ) ) {
130 $mmfl['quiet'] = true;
135 * @param string $fileName
136 * @return array List of absolute extension paths
138 private function readFile( $fileName ) {
142 $fileLines = file( $fileName );
143 if ( $fileLines === false ) {
144 $this->hasError
= true;
145 $this->error( "Unable to open list file $fileName." );
149 # Strip comments, discard empty lines, and trim leading and trailing
150 # whitespace. Comments start with '#' and extend to the end of the line.
151 foreach ( $fileLines as $extension ) {
152 $extension = trim( preg_replace( '/#.*/', '', $extension ) );
153 if ( $extension !== '' ) {
154 # Paths may use the string $IP to be substituted by the actual value
155 $extension = str_replace( '$IP', $IP, $extension );
156 if ( file_exists( $extension ) ) {
157 $files[] = $extension;
159 $this->hasError
= true;
160 $this->error( "Extension {$extension} doesn't exist" );
169 require_once RUN_MAINTENANCE_IF_MAIN
;
172 foreach ( $mmfl['setupFiles'] as $fileName ) {
173 if ( strval( $fileName ) === '' ) {
176 if ( empty( $mmfl['quiet'] ) ) {
177 fwrite( STDERR
, "Loading data from $fileName\n" );
179 // Using extension.json or skin.json
180 if ( substr( $fileName, -strlen( '.json' ) ) === '.json' ) {
181 $queue[$fileName] = 1;
183 require_once $fileName;
188 $registry = new ExtensionRegistry();
189 $data = $registry->readFromQueue( $queue );
190 foreach ( [ 'wgExtensionMessagesFiles', 'wgMessagesDirs' ] as $var ) {
191 if ( isset( $data['globals'][$var] ) ) {
192 $GLOBALS[$var] = array_merge( $data['globals'][$var], $GLOBALS[$var] );
197 fwrite( STDERR
, "\n" );
200 "## This file is generated by mergeMessageFileList.php. Do not edit it directly.\n\n" .
201 "if ( defined( 'MW_NO_EXTENSION_MESSAGES' ) ) return;\n\n" .
202 '$wgExtensionMessagesFiles = ' . var_export( $wgExtensionMessagesFiles, true ) . ";\n\n" .
203 '$wgMessagesDirs = ' . var_export( $wgMessagesDirs, true ) . ";\n\n";
211 foreach ( $dirs as $dir ) {
212 $s = preg_replace( "/'" . preg_quote( $dir, '/' ) . "([^']*)'/", '"$IP\1"', $s );
215 if ( isset( $mmfl['output'] ) ) {
216 file_put_contents( $mmfl['output'], $s );