MediaWiki  master
convertExtensionToRegistration.php
Go to the documentation of this file.
1 <?php
2 
3 require_once __DIR__ . '/Maintenance.php';
4 
6 
7  protected $custom = [
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' => 'removeAutodiscoveredParserTestFiles',
17  ];
18 
24  protected $formerGlobals = [
25  'TrackingCategories',
26  ];
27 
34  'SpecialPageGroups' => 'deprecated', // Deprecated 1.21, removed in 1.26
35  ];
36 
42  protected $promote = [
43  'name',
44  'namemsg',
45  'version',
46  'author',
47  'url',
48  'description',
49  'descriptionmsg',
50  'license-name',
51  'type',
52  ];
53 
54  private $json, $dir, $hasWarning = false;
55 
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 );
62  $this->addOption( 'config-prefix', 'Custom prefix for configuration settings', false, true );
63  }
64 
65  protected function getAllGlobals() {
66  $processor = new ReflectionClass( ExtensionProcessor::class );
67  $settings = $processor->getProperty( 'globalSettings' );
68  $settings->setAccessible( true );
69  return array_merge( $settings->getValue(), $this->formerGlobals );
70  }
71 
72  public function execute() {
73  // Extensions will do stuff like $wgResourceModules += array(...) which is a
74  // fatal unless an array is already set. So set an empty value.
75  // And use the weird $__settings name to avoid any conflicts
76  // with real poorly named settings.
77  $__settings = array_merge( $this->getAllGlobals(), array_keys( $this->custom ) );
78  foreach ( $__settings as $var ) {
79  $var = 'wg' . $var;
80  $$var = [];
81  }
82  unset( $var );
83  $arg = $this->getArg( 0 );
84  if ( !is_file( $arg ) ) {
85  $this->fatalError( "$arg is not a file." );
86  }
87  require $arg;
88  unset( $arg );
89  // Try not to create any local variables before this line
90  $vars = get_defined_vars();
91  unset( $vars['this'] );
92  unset( $vars['__settings'] );
93  $this->dir = dirname( realpath( $this->getArg( 0 ) ) );
94  $this->json = [];
95  $globalSettings = $this->getAllGlobals();
96  $configPrefix = $this->getOption( 'config-prefix', 'wg' );
97  if ( $configPrefix !== 'wg' ) {
98  $this->json['config']['_prefix'] = $configPrefix;
99  }
100  foreach ( $vars as $name => $value ) {
101  $realName = substr( $name, 2 ); // Strip 'wg'
102  if ( $realName === false ) {
103  continue;
104  }
105 
106  // If it's an empty array that we likely set, skip it
107  if ( is_array( $value ) && count( $value ) === 0 && in_array( $realName, $__settings ) ) {
108  continue;
109  }
110 
111  if ( isset( $this->custom[$realName] ) ) {
112  call_user_func_array( [ $this, $this->custom[$realName] ],
113  [ $realName, $value, $vars ] );
114  } elseif ( in_array( $realName, $globalSettings ) ) {
115  $this->json[$realName] = $value;
116  } elseif ( array_key_exists( $realName, $this->noLongerSupportedGlobals ) ) {
117  $this->output( 'Warning: Skipped global "' . $name . '" (' .
118  $this->noLongerSupportedGlobals[$realName] . '). ' .
119  "Please update the entry point before convert to registration.\n" );
120  $this->hasWarning = true;
121  } elseif ( strpos( $name, $configPrefix ) === 0 ) {
122  // Most likely a config setting
123  $this->json['config'][substr( $name, strlen( $configPrefix ) )] = [ 'value' => $value ];
124  } elseif ( $configPrefix !== 'wg' && strpos( $name, 'wg' ) === 0 ) {
125  // Warn about this
126  $this->output( 'Warning: Skipped global "' . $name . '" (' .
127  'config prefix is "' . $configPrefix . '"). ' .
128  "Please check that this setting isn't needed.\n" );
129  }
130  }
131 
132  // check, if the extension requires composer libraries
133  if ( $this->needsComposerAutoloader( dirname( $this->getArg( 0 ) ) ) ) {
134  // set the load composer autoloader automatically property
135  $this->output( "Detected composer dependencies, setting 'load_composer_autoloader' to true.\n" );
136  $this->json['load_composer_autoloader'] = true;
137  }
138 
139  // Move some keys to the top
140  $out = [];
141  foreach ( $this->promote as $key ) {
142  if ( isset( $this->json[$key] ) ) {
143  $out[$key] = $this->json[$key];
144  unset( $this->json[$key] );
145  }
146  }
147  // Set a requirement on the MediaWiki version that the current MANIFEST_VERSION
148  // was introduced in.
149  $out['requires'] = [
151  ];
152  $out += $this->json;
153  // Put this at the bottom
154  $out['manifest_version'] = ExtensionRegistry::MANIFEST_VERSION;
155  $type = $this->hasOption( 'skin' ) ? 'skin' : 'extension';
156  $fname = "{$this->dir}/$type.json";
157  $prettyJSON = FormatJson::encode( $out, "\t", FormatJson::ALL_OK );
158  file_put_contents( $fname, $prettyJSON . "\n" );
159  $this->output( "Wrote output to $fname.\n" );
160  if ( $this->hasWarning ) {
161  $this->output( "Found warnings! Please resolve the warnings and rerun this script.\n" );
162  }
163  }
164 
165  protected function handleExtensionFunctions( $realName, $value ) {
166  foreach ( $value as $func ) {
167  if ( $func instanceof Closure ) {
168  $this->fatalError( "Error: Closures cannot be converted to JSON. " .
169  "Please move your extension function somewhere else."
170  );
171  } elseif ( function_exists( $func ) ) {
172  // check if $func exists in the global scope
173  $this->fatalError( "Error: Global functions cannot be converted to JSON. " .
174  "Please move your extension function ($func) into a class."
175  );
176  }
177  }
178 
179  $this->json[$realName] = $value;
180  }
181 
182  protected function handleMessagesDirs( $realName, $value ) {
183  foreach ( $value as $key => $dirs ) {
184  foreach ( (array)$dirs as $dir ) {
185  $this->json[$realName][$key][] = $this->stripPath( $dir, $this->dir );
186  }
187  }
188  }
189 
190  protected function handleExtensionMessagesFiles( $realName, $value, $vars ) {
191  foreach ( $value as $key => $file ) {
192  $strippedFile = $this->stripPath( $file, $this->dir );
193  if ( isset( $vars['wgMessagesDirs'][$key] ) ) {
194  $this->output(
195  "Note: Ignoring PHP shim $strippedFile. " .
196  "If your extension no longer supports versions of MediaWiki " .
197  "older than 1.23.0, you can safely delete it.\n"
198  );
199  } else {
200  $this->json[$realName][$key] = $strippedFile;
201  }
202  }
203  }
204 
205  private function stripPath( $val, $dir ) {
206  if ( $val === $dir ) {
207  $val = '';
208  } elseif ( strpos( $val, $dir ) === 0 ) {
209  // +1 is for the trailing / that won't be in $this->dir
210  $val = substr( $val, strlen( $dir ) + 1 );
211  }
212 
213  return $val;
214  }
215 
216  protected function removeAbsolutePath( $realName, $value ) {
217  $out = [];
218  foreach ( $value as $key => $val ) {
219  $out[$key] = $this->stripPath( $val, $this->dir );
220  }
221  $this->json[$realName] = $out;
222  }
223 
224  protected function removeAutodiscoveredParserTestFiles( $realName, $value ) {
225  $out = [];
226  foreach ( $value as $key => $val ) {
227  $path = $this->stripPath( $val, $this->dir );
228  // When path starts with tests/parser/ the file would be autodiscovered with
229  // extension registry, so no need to add it to extension.json
230  if ( substr( $path, 0, 13 ) !== 'tests/parser/' || substr( $path, -4 ) !== '.txt' ) {
231  $out[$key] = $path;
232  }
233  }
234  // in the best case all entries are filtered out
235  if ( $out ) {
236  $this->json[$realName] = $out;
237  }
238  }
239 
240  protected function handleCredits( $realName, $value ) {
241  $keys = array_keys( $value );
242  $this->json['type'] = $keys[0];
243  $values = array_values( $value );
244  foreach ( $values[0][0] as $name => $val ) {
245  if ( $name !== 'path' ) {
246  $this->json[$name] = $val;
247  }
248  }
249  }
250 
251  public function handleHooks( $realName, $value ) {
252  foreach ( $value as $hookName => &$handlers ) {
253  if ( $hookName === 'UnitTestsList' ) {
254  $this->output( "Note: the UnitTestsList hook is no longer necessary as " .
255  "long as your tests are located in the \"tests/phpunit/\" directory. " .
256  "Please see <https://www.mediawiki.org/wiki/Manual:PHP_unit_testing/" .
257  "Writing_unit_tests_for_extensions#Register_your_tests> for more details.\n"
258  );
259  }
260  foreach ( $handlers as $func ) {
261  if ( $func instanceof Closure ) {
262  $this->fatalError( "Error: Closures cannot be converted to JSON. " .
263  "Please move the handler for $hookName somewhere else."
264  );
265  } elseif ( function_exists( $func ) ) {
266  // Check if $func exists in the global scope
267  $this->fatalError( "Error: Global functions cannot be converted to JSON. " .
268  "Please move the handler for $hookName inside a class."
269  );
270  }
271  }
272  if ( count( $handlers ) === 1 ) {
273  $handlers = $handlers[0];
274  }
275  }
276  $this->json[$realName] = $value;
277  }
278 
283  protected function handleResourceModules( $realName, $value ) {
284  $defaults = [];
285  $remote = $this->hasOption( 'skin' ) ? 'remoteSkinPath' : 'remoteExtPath';
286  foreach ( $value as $name => $data ) {
287  if ( isset( $data['localBasePath'] ) ) {
288  $data['localBasePath'] = $this->stripPath( $data['localBasePath'], $this->dir );
289  if ( !$defaults ) {
290  $defaults['localBasePath'] = $data['localBasePath'];
291  unset( $data['localBasePath'] );
292  if ( isset( $data[$remote] ) ) {
293  $defaults[$remote] = $data[$remote];
294  unset( $data[$remote] );
295  }
296  } else {
297  if ( $data['localBasePath'] === $defaults['localBasePath'] ) {
298  unset( $data['localBasePath'] );
299  }
300  if ( isset( $data[$remote] ) && isset( $defaults[$remote] )
301  && $data[$remote] === $defaults[$remote]
302  ) {
303  unset( $data[$remote] );
304  }
305  }
306  }
307 
308  $this->json[$realName][$name] = $data;
309  }
310  if ( $defaults ) {
311  $this->json['ResourceFileModulePaths'] = $defaults;
312  }
313  }
314 
315  protected function needsComposerAutoloader( $path ) {
316  $path .= '/composer.json';
317  if ( file_exists( $path ) ) {
318  // assume, that the composer.json file is in the root of the extension path
319  $composerJson = new ComposerJson( $path );
320  // check, if there are some dependencies in the require section
321  if ( $composerJson->getRequiredDependencies() ) {
322  return true;
323  }
324  }
325  return false;
326  }
327 }
328 
329 $maintClass = ConvertExtensionToRegistration::class;
330 require_once RUN_MAINTENANCE_IF_MAIN;
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42
const MANIFEST_VERSION
Version of the highest supported manifest version Note: Update MANIFEST_VERSION_MW_VERSION when chang...
getArg( $argId=0, $default=null)
Get an argument.
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
getOption( $name, $default=null)
Get an option, or return the default.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:82
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
string [] $noLongerSupportedGlobals
No longer supported globals (with reason) should not be converted and emit a warning.
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
hasOption( $name)
Checks to see if a particular option exists.
handleExtensionMessagesFiles( $realName, $value, $vars)
const MANIFEST_VERSION_MW_VERSION
MediaWiki version constraint representing what the current highest MANIFEST_VERSION is supported in...
addDescription( $text)
Set the description text.
const MEDIAWIKI_CORE
"requires" key that applies to MediaWiki core/$wgVersion
addArg( $arg, $description, $required=true)
Add some args that are needed.
output( $out, $channel=null)
Throw some output to the user.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
string [] string [] $promote
Keys that should be put at the top of the generated JSON file (T86608)
Reads a composer.json file and provides accessors to get its hash and the required dependencies...
Definition: ComposerJson.php:9
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
string [] $formerGlobals
Things that were formerly globals and should still be converted.