maintenance/validateRegistrationFile.php

   1 <?php
   2
   3 require_once __DIR__ . '/Maintenance.php';
   4
   5 use Composer\Spdx\SpdxLicenses;
   6 use JsonSchema\Validator;
   7
   8 class ValidateRegistrationFile extends Maintenance {
   9         public function __construct() {
  10                 parent::__construct();
  11                 $this->addArg( 'path', 'Path to extension.json/skin.json file.', true );
  12         }
  13         public function execute() {
  14                 if ( !class_exists( Validator::class ) ) {
  15                         $this->error( 'The JsonSchema library cannot be found, please install it through composer.', 1 );
  16                 } elseif ( !class_exists( SpdxLicenses::class ) ) {
  17                         $this->error(
  18                                 'The spdx-licenses library cannot be found, please install it through composer.', 1
  19                         );
  20                 }
  21
  22                 $path = $this->getArg( 0 );
  23                 $data = json_decode( file_get_contents( $path ) );
  24                 if ( !is_object( $data ) ) {
  25                         $this->error( "$path is not a valid JSON file.", 1 );
  26                 }
  27                 if ( !isset( $data->manifest_version ) ) {
  28                         $this->output( "Warning: No manifest_version set, assuming 1.\n" );
  29                         // For backwards-compatability assume 1
  30                         $data->manifest_version = 1;
  31                 }
  32                 $version = $data->manifest_version;
  33                 if ( $version !== ExtensionRegistry::MANIFEST_VERSION ) {
  34                         $schemaPath = dirname( __DIR__ ) . "/docs/extension.schema.v$version.json";
  35                 } else {
  36                         $schemaPath = dirname( __DIR__ ) . '/docs/extension.schema.json';
  37                 }
  38
  39                 if ( $version < ExtensionRegistry::OLDEST_MANIFEST_VERSION
  40                         || $version > ExtensionRegistry::MANIFEST_VERSION
  41                 ) {
  42                         $this->error( "Error: $path is using a non-supported schema version, it should use "
  43                                 . ExtensionRegistry::MANIFEST_VERSION, 1 );
  44                 } elseif ( $version < ExtensionRegistry::MANIFEST_VERSION ) {
  45                         $this->output( "Warning: $path is using a deprecated schema, and should be updated to "
  46                                 . ExtensionRegistry::MANIFEST_VERSION . "\n" );
  47                 }
  48
  49                 $licenseError = false;
  50                 // Check if it's a string, if not, schema validation will display an error
  51                 if ( isset( $data->{'license-name'} ) && is_string( $data->{'license-name'} ) ) {
  52                         $licenses = new SpdxLicenses();
  53                         $valid = $licenses->validate( $data->{'license-name'} );
  54                         if ( !$valid ) {
  55                                 $licenseError = '[license-name] Invalid SPDX license identifier, '
  56                                         . 'see <https://spdx.org/licenses/>';
  57                         }
  58                 }
  59
  60                 $validator = new Validator;
  61                 $validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] );
  62                 if ( $validator->isValid() && !$licenseError ) {
  63                         $this->output( "$path validates against the version $version schema!\n" );
  64                 } else {
  65                         foreach ( $validator->getErrors() as $error ) {
  66                                 $this->output( "[{$error['property']}] {$error['message']}\n" );
  67                         }
  68                         if ( $licenseError ) {
  69                                 $this->output( "$licenseError\n" );
  70                         }
  71                         $this->error( "$path does not validate.", 1 );
  72                 }
  73         }
  74 }
  75
  76 $maintClass = 'ValidateRegistrationFile';
  77 require_once RUN_MAINTENANCE_IF_MAIN;