includes/registration/ExtensionJsonValidator.php

   1 <?php
   2
   3 /**
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  * http://www.gnu.org/copyleft/gpl.html
  18  *
  19  * @file
  20  */
  21
  22 use Composer\Spdx\SpdxLicenses;
  23 use JsonSchema\Validator;
  24 use Seld\JsonLint\JsonParser;
  25 use Seld\JsonLint\ParsingException;
  26
  27 /**
  28  * Validate extension.json files against their JSON schema.
  29  *
  30  * This is used for static validation from the command-line via
  31  * validateRegistrationFile.php, and the PHPUnit structure test suite
  32  * (ExtensionJsonValidationTest).
  33  *
  34  * The files are normally read by the ExtensionRegistry
  35  * and ExtensionProcessor classes.
  36  *
  37  * @since 1.29
  38  */
  39 class ExtensionJsonValidator {
  40
  41         /**
  42          * @var callable
  43          */
  44         private $missingDepCallback;
  45
  46         /**
  47          * @param callable $missingDepCallback
  48          */
  49         public function __construct( callable $missingDepCallback ) {
  50                 $this->missingDepCallback = $missingDepCallback;
  51         }
  52
  53         /**
  54          * @codeCoverageIgnore
  55          * @return bool
  56          */
  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
  81         /**
  82          * @param string $path file to validate
  83          * @return bool true if passes validation
  84          * @throws ExtensionJsonValidationError on any failure
  85          */
  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 ) ) {
  99                         throw new ExtensionJsonValidationError(
 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 ) {
 108                         throw new ExtensionJsonValidationError(
 109                                 "$path is using a non-supported schema version"
 110                         );
 111                 }
 112
 113                 if ( $version > ExtensionRegistry::MANIFEST_VERSION ) {
 114                         throw new ExtensionJsonValidationError(
 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                 $validator = new Validator;
 145                 $validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] );
 146                 if ( $validator->isValid() && !$extraErrors ) {
 147                         // All good.
 148                         return true;
 149                 }
 150
 151                 $out = "$path did not pass validation.\n";
 152                 foreach ( $validator->getErrors() as $error ) {
 153                         $out .= "[{$error['property']}] {$error['message']}\n";
 154                 }
 155                 if ( $extraErrors ) {
 156                         $out .= implode( "\n", $extraErrors ) . "\n";
 157                 }
 158                 throw new ExtensionJsonValidationError( $out );
 159         }
 160 }