3 require_once __DIR__
. '/Maintenance.php';
5 class ConvertExtensionToRegistration
extends Maintenance
{
8 'MessagesDirs' => 'handleMessagesDirs',
9 'ExtensionMessagesFiles' => 'handleExtensionMessagesFiles',
10 'AutoloadClasses' => 'removeAbsolutePath',
11 'ExtensionCredits' => 'handleCredits',
12 'ResourceModules' => 'handleResourceModules',
13 'ResourceModuleSkinStyles' => 'handleResourceModules',
14 'Hooks' => 'handleHooks',
15 'ExtensionFunctions' => 'handleExtensionFunctions',
16 'ParserTestFiles' => 'removeAbsolutePath',
20 * Things that were formerly globals and should still be converted
24 protected $formerGlobals = [
29 * No longer supported globals (with reason) should not be converted and emit a warning
33 protected $noLongerSupportedGlobals = [
34 'SpecialPageGroups' => 'deprecated', // Deprecated 1.21, removed in 1.26
38 * Keys that should be put at the top of the generated JSON file (T86608)
42 protected $promote = [
54 private $json, $dir, $hasWarning = false;
56 public function __construct() {
57 parent
::__construct();
58 $this->addDescription( 'Converts extension entry points to the new JSON registration format' );
59 $this->addArg( 'path', 'Location to the PHP entry point you wish to convert',
60 /* $required = */ true );
61 $this->addOption( 'skin', 'Whether to write to skin.json', false, false );
64 protected function getAllGlobals() {
65 $processor = new ReflectionClass( 'ExtensionProcessor' );
66 $settings = $processor->getProperty( 'globalSettings' );
67 $settings->setAccessible( true );
68 return $settings->getValue() +
$this->formerGlobals
;
71 public function execute() {
72 // Extensions will do stuff like $wgResourceModules += array(...) which is a
73 // fatal unless an array is already set. So set an empty value.
74 // And use the weird $__settings name to avoid any conflicts
75 // with real poorly named settings.
76 $__settings = array_merge( $this->getAllGlobals(), array_keys( $this->custom
) );
77 foreach ( $__settings as $var ) {
82 $arg = $this->getArg( 0 );
83 if ( !is_file( $arg ) ) {
84 $this->error( "$arg is not a file.", true );
88 // Try not to create any local variables before this line
89 $vars = get_defined_vars();
90 unset( $vars['this'] );
91 unset( $vars['__settings'] );
92 $this->dir
= dirname( realpath( $this->getArg( 0 ) ) );
94 $globalSettings = $this->getAllGlobals();
95 foreach ( $vars as $name => $value ) {
96 $realName = substr( $name, 2 ); // Strip 'wg'
98 // If it's an empty array that we likely set, skip it
99 if ( is_array( $value ) && count( $value ) === 0 && in_array( $realName, $__settings ) ) {
103 if ( isset( $this->custom
[$realName] ) ) {
104 call_user_func_array( [ $this, $this->custom
[$realName] ],
105 [ $realName, $value, $vars ] );
106 } elseif ( in_array( $realName, $globalSettings ) ) {
107 $this->json
[$realName] = $value;
108 } elseif ( array_key_exists( $realName, $this->noLongerSupportedGlobals
) ) {
109 $this->output( 'Warning: Skipped global "' . $name . '" (' .
110 $this->noLongerSupportedGlobals
[$realName] . '). ' .
111 "Please update the entry point before convert to registration.\n" );
112 $this->hasWarning
= true;
113 } elseif ( strpos( $name, 'wg' ) === 0 ) {
114 // Most likely a config setting
115 $this->json
['config'][$realName] = $value;
119 // check, if the extension requires composer libraries
120 if ( $this->needsComposerAutoloader( dirname( $this->getArg( 0 ) ) ) ) {
121 // set the load composer autoloader automatically property
122 $this->output( "Detected composer dependencies, setting 'load_composer_autoloader' to true.\n" );
123 $this->json
['load_composer_autoloader'] = true;
126 // Move some keys to the top
128 foreach ( $this->promote
as $key ) {
129 if ( isset( $this->json
[$key] ) ) {
130 $out[$key] = $this->json
[$key];
131 unset( $this->json
[$key] );
135 // Put this at the bottom
136 $out['manifest_version'] = ExtensionRegistry
::MANIFEST_VERSION
;
137 $type = $this->hasOption( 'skin' ) ?
'skin' : 'extension';
138 $fname = "{$this->dir}/$type.json";
139 $prettyJSON = FormatJson
::encode( $out, "\t", FormatJson
::ALL_OK
);
140 file_put_contents( $fname, $prettyJSON . "\n" );
141 $this->output( "Wrote output to $fname.\n" );
142 if ( $this->hasWarning
) {
143 $this->output( "Found warnings! Please resolve the warnings and rerun this script.\n" );
147 protected function handleExtensionFunctions( $realName, $value ) {
148 foreach ( $value as $func ) {
149 if ( $func instanceof Closure
) {
150 $this->error( "Error: Closures cannot be converted to JSON. " .
151 "Please move your extension function somewhere else.", 1
154 // check if $func exists in the global scope
155 if ( function_exists( $func ) ) {
156 $this->error( "Error: Global functions cannot be converted to JSON. " .
157 "Please move your extension function ($func) into a class.", 1
162 $this->json
[$realName] = $value;
165 protected function handleMessagesDirs( $realName, $value ) {
166 foreach ( $value as $key => $dirs ) {
167 foreach ( (array)$dirs as $dir ) {
168 $this->json
[$realName][$key][] = $this->stripPath( $dir, $this->dir
);
173 protected function handleExtensionMessagesFiles( $realName, $value, $vars ) {
174 foreach ( $value as $key => $file ) {
175 $strippedFile = $this->stripPath( $file, $this->dir
);
176 if ( isset( $vars['wgMessagesDirs'][$key] ) ) {
178 "Note: Ignoring PHP shim $strippedFile. " .
179 "If your extension no longer supports versions of MediaWiki " .
180 "older than 1.23.0, you can safely delete it.\n"
183 $this->json
[$realName][$key] = $strippedFile;
188 private function stripPath( $val, $dir ) {
189 if ( $val === $dir ) {
191 } elseif ( strpos( $val, $dir ) === 0 ) {
192 // +1 is for the trailing / that won't be in $this->dir
193 $val = substr( $val, strlen( $dir ) +
1 );
199 protected function removeAbsolutePath( $realName, $value ) {
201 foreach ( $value as $key => $val ) {
202 $out[$key] = $this->stripPath( $val, $this->dir
);
204 $this->json
[$realName] = $out;
207 protected function handleCredits( $realName, $value ) {
208 $keys = array_keys( $value );
209 $this->json
['type'] = $keys[0];
210 $values = array_values( $value );
211 foreach ( $values[0][0] as $name => $val ) {
212 if ( $name !== 'path' ) {
213 $this->json
[$name] = $val;
218 public function handleHooks( $realName, $value ) {
219 foreach ( $value as $hookName => &$handlers ) {
220 foreach ( $handlers as $func ) {
221 if ( $func instanceof Closure
) {
222 $this->error( "Error: Closures cannot be converted to JSON. " .
223 "Please move the handler for $hookName somewhere else.", 1
226 // Check if $func exists in the global scope
227 if ( function_exists( $func ) ) {
228 $this->error( "Error: Global functions cannot be converted to JSON. " .
229 "Please move the handler for $hookName inside a class.", 1
233 if ( count( $handlers ) === 1 ) {
234 $handlers = $handlers[0];
237 $this->json
[$realName] = $value;
240 protected function handleResourceModules( $realName, $value ) {
242 $remote = $this->hasOption( 'skin' ) ?
'remoteSkinPath' : 'remoteExtPath';
243 foreach ( $value as $name => $data ) {
244 if ( isset( $data['localBasePath'] ) ) {
245 $data['localBasePath'] = $this->stripPath( $data['localBasePath'], $this->dir
);
247 $defaults['localBasePath'] = $data['localBasePath'];
248 unset( $data['localBasePath'] );
249 if ( isset( $data[$remote] ) ) {
250 $defaults[$remote] = $data[$remote];
251 unset( $data[$remote] );
254 if ( $data['localBasePath'] === $defaults['localBasePath'] ) {
255 unset( $data['localBasePath'] );
257 if ( isset( $data[$remote] ) && isset( $defaults[$remote] )
258 && $data[$remote] === $defaults[$remote]
260 unset( $data[$remote] );
265 $this->json
[$realName][$name] = $data;
268 $this->json
['ResourceFileModulePaths'] = $defaults;
272 protected function needsComposerAutoloader( $path ) {
273 $path .= '/composer.json';
274 if ( file_exists( $path ) ) {
275 // assume, that the composer.json file is in the root of the extension path
276 $composerJson = new ComposerJson( $path );
277 // check, if there are some dependencies in the require section
278 if ( $composerJson->getRequiredDependencies() ) {
286 $maintClass = 'ConvertExtensionToRegistration';
287 require_once RUN_MAINTENANCE_IF_MAIN
;