MediaWiki REL1_34
updateExtensionJsonSchema.php
Go to the documentation of this file.
1<?php
2
3require_once __DIR__ . '/Maintenance.php';
4
6
7 public function __construct() {
8 parent::__construct();
9 $this->addDescription( 'Updates extension.json files to the latest manifest_version' );
10 $this->addArg( 'path', 'Location to the extension.json or skin.json you wish to convert',
11 /* $required = */ true );
12 }
13
14 public function execute() {
15 $filename = $this->getArg( 0 );
16 if ( !is_readable( $filename ) ) {
17 $this->fatalError( "Error: Unable to read $filename" );
18 }
19
20 $json = FormatJson::decode( file_get_contents( $filename ), true );
21 if ( !is_array( $json ) ) {
22 $this->fatalError( "Error: Invalid JSON" );
23 }
24
25 if ( !isset( $json['manifest_version'] ) ) {
26 $json['manifest_version'] = 1;
27 }
28
29 if ( $json['manifest_version'] == ExtensionRegistry::MANIFEST_VERSION ) {
30 $this->output( "Already at the latest version: {$json['manifest_version']}\n" );
31 return;
32 }
33
34 while ( $json['manifest_version'] !== ExtensionRegistry::MANIFEST_VERSION ) {
35 $json['manifest_version'] += 1;
36 $func = "updateTo{$json['manifest_version']}";
37 // @phan-suppress-next-line PhanUndeclaredMethod
38 $this->$func( $json );
39 }
40
41 file_put_contents( $filename, FormatJson::encode( $json, "\t", FormatJson::ALL_OK ) . "\n" );
42 $this->output( "Updated to {$json['manifest_version']}...\n" );
43 }
44
45 protected function updateTo2( &$json ) {
46 if ( isset( $json['config'] ) ) {
47 $config = $json['config'];
48 $json['config'] = [];
49 if ( isset( $config['_prefix'] ) ) {
50 $json = wfArrayInsertAfter( $json, [
51 'config_prefix' => $config['_prefix']
52 ], 'config' );
53 unset( $config['_prefix'] );
54 }
55
56 foreach ( $config as $name => $value ) {
57 if ( $name[0] !== '@' ) {
58 $json['config'][$name] = [ 'value' => $value ];
59 if ( isset( $value[ExtensionRegistry::MERGE_STRATEGY] ) ) {
60 $json['config'][$name]['merge_strategy'] = $value[ExtensionRegistry::MERGE_STRATEGY];
61 unset( $json['config'][$name]['value'][ExtensionRegistry::MERGE_STRATEGY] );
62 }
63 if ( isset( $config["@$name"] ) ) {
64 // Put 'description' first for better human-legibility.
65 $json['config'][$name] = array_merge(
66 [ 'description' => $config["@$name"] ],
67 $json['config'][$name]
68 );
69 }
70 }
71 }
72 }
73 }
74}
75
76$maintClass = UpdateExtensionJsonSchema::class;
77require_once RUN_MAINTENANCE_IF_MAIN;
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
const RUN_MAINTENANCE_IF_MAIN
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
addArg( $arg, $description, $required=true)
Add some args that are needed.
output( $out, $channel=null)
Throw some output to the user.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
Config $config
Accessible via getConfig()
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.