MediaWiki REL1_39
ExtensionJsonValidator.php
Go to the documentation of this file.
1<?php
2
22use Composer\Spdx\SpdxLicenses;
23use JsonSchema\Validator;
24use Seld\JsonLint\JsonParser;
25use Seld\JsonLint\ParsingException;
26
40
44 private $missingDepCallback;
45
49 public function __construct( callable $missingDepCallback ) {
50 $this->missingDepCallback = $missingDepCallback;
51 }
52
57 public function checkDependencies() {
58 if ( !class_exists( Validator::class ) ) {
59 call_user_func( $this->missingDepCallback,
60 'The JsonSchema library cannot be found, please install it through composer.'
61 );
62 return false;
63 }
64
65 if ( !class_exists( SpdxLicenses::class ) ) {
66 call_user_func( $this->missingDepCallback,
67 'The spdx-licenses library cannot be found, please install it through composer.'
68 );
69 return false;
70 }
71
72 if ( !class_exists( JsonParser::class ) ) {
73 call_user_func( $this->missingDepCallback,
74 'The JSON lint library cannot be found, please install it through composer.'
75 );
76 }
77
78 return true;
79 }
80
86 public function validate( $path ) {
87 $contents = file_get_contents( $path );
88 $jsonParser = new JsonParser();
89 try {
90 $data = $jsonParser->parse( $contents, JsonParser::DETECT_KEY_CONFLICTS );
91 } catch ( ParsingException $e ) {
92 if ( $e instanceof \Seld\JsonLint\DuplicateKeyException ) {
93 throw new ExtensionJsonValidationError( $e->getMessage() );
94 }
95 throw new ExtensionJsonValidationError( "$path is not valid JSON" );
96 }
97
98 if ( !isset( $data->manifest_version ) ) {
100 "$path does not have manifest_version set." );
101 }
102
103 $version = $data->manifest_version;
104 $schemaPath = __DIR__ . "/../../docs/extension.schema.v$version.json";
105
106 // Not too old
107 if ( $version < ExtensionRegistry::OLDEST_MANIFEST_VERSION ) {
109 "$path is using a non-supported schema version"
110 );
111 }
112
113 if ( $version > ExtensionRegistry::MANIFEST_VERSION ) {
115 "$path is using a non-supported schema version"
116 );
117 }
118
119 $extraErrors = [];
120 // Check if it's a string, if not, schema validation will display an error
121 if ( isset( $data->{'license-name'} ) && is_string( $data->{'license-name'} ) ) {
122 $licenses = new SpdxLicenses();
123 $valid = $licenses->validate( $data->{'license-name'} );
124 if ( !$valid ) {
125 $extraErrors[] = '[license-name] Invalid SPDX license identifier, '
126 . 'see <https://spdx.org/licenses/>';
127 }
128 }
129 if ( isset( $data->url ) && is_string( $data->url ) ) {
130 $parsed = wfParseUrl( $data->url );
131 $mwoUrl = false;
132 if ( $parsed['host'] === 'www.mediawiki.org' ) {
133 $mwoUrl = true;
134 } elseif ( $parsed['host'] === 'mediawiki.org' ) {
135 $mwoUrl = true;
136 $extraErrors[] = '[url] Should use www.mediawiki.org domain';
137 }
138
139 if ( $mwoUrl && $parsed['scheme'] !== 'https' ) {
140 $extraErrors[] = '[url] Should use HTTPS for www.mediawiki.org URLs';
141 }
142 }
143
144 // Deprecated stuff
145 if ( isset( $data->ParserTestFiles ) ) {
146 // phpcs:ignore Generic.Files.LineLength.TooLong
147 $extraErrors[] = '[ParserTestFiles] DEPRECATED: see <https://www.mediawiki.org/wiki/Manual:Extension.json/Schema#ParserTestFiles>';
148 }
149
150 $validator = new Validator;
151 $validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] );
152 if ( $validator->isValid() && !$extraErrors ) {
153 // All good.
154 return true;
155 }
156
157 $out = "$path did not pass validation.\n";
158 foreach ( $validator->getErrors() as $error ) {
159 $out .= "[{$error['property']}] {$error['message']}\n";
160 }
161 if ( $extraErrors ) {
162 $out .= implode( "\n", $extraErrors ) . "\n";
163 }
164 throw new ExtensionJsonValidationError( $out );
165 }
166}
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Validate extension.json files against their JSON schema.
__construct(callable $missingDepCallback)