missingDepCallback = $missingDepCallback; } /** * @codeCoverageIgnore * @return bool */ public function checkDependencies() { if ( !class_exists( Validator::class ) ) { call_user_func( $this->missingDepCallback, 'The JsonSchema library cannot be found, please install it through composer.' ); return false; } elseif ( !class_exists( SpdxLicenses::class ) ) { call_user_func( $this->missingDepCallback, 'The spdx-licenses library cannot be found, please install it through composer.' ); return false; } return true; } /** * @param string $path file to validate * @return bool true if passes validation * @throws ExtensionJsonValidationError on any failure */ public function validate( $path ) { $data = json_decode( file_get_contents( $path ) ); if ( !is_object( $data ) ) { throw new ExtensionJsonValidationError( "$path is not valid JSON" ); } if ( !isset( $data->manifest_version ) ) { throw new ExtensionJsonValidationError( "$path does not have manifest_version set." ); } $version = $data->manifest_version; $schemaPath = __DIR__ . "/../../docs/extension.schema.v$version.json"; // Not too old if ( $version < ExtensionRegistry::OLDEST_MANIFEST_VERSION ) { throw new ExtensionJsonValidationError( "$path is using a non-supported schema version" ); } elseif ( $version > ExtensionRegistry::MANIFEST_VERSION ) { throw new ExtensionJsonValidationError( "$path is using a non-supported schema version" ); } $extraErrors = []; // Check if it's a string, if not, schema validation will display an error if ( isset( $data->{'license-name'} ) && is_string( $data->{'license-name'} ) ) { $licenses = new SpdxLicenses(); $valid = $licenses->validate( $data->{'license-name'} ); if ( !$valid ) { $extraErrors[] = '[license-name] Invalid SPDX license identifier, ' . 'see '; } } if ( isset( $data->url ) && is_string( $data->url ) ) { $parsed = wfParseUrl( $data->url ); $mwoUrl = false; if ( $parsed['host'] === 'www.mediawiki.org' ) { $mwoUrl = true; } elseif ( $parsed['host'] === 'mediawiki.org' ) { $mwoUrl = true; $extraErrors[] = '[url] Should use www.mediawiki.org domain'; } if ( $mwoUrl && $parsed['scheme'] !== 'https' ) { $extraErrors[] = '[url] Should use HTTPS for www.mediawiki.org URLs'; } } $validator = new Validator; $validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] ); if ( $validator->isValid() && !$extraErrors ) { // All good. return true; } else { $out = "$path did not pass validation.\n"; foreach ( $validator->getErrors() as $error ) { $out .= "[{$error['property']}] {$error['message']}\n"; } if ( $extraErrors ) { $out .= implode( "\n", $extraErrors ) . "\n"; } throw new ExtensionJsonValidationError( $out ); } } }