Merge "Improve docs for Title::getInternalURL/getCanonicalURL"

[lhc/web/wiklou.git] / includes / registration / ExtensionJsonValidator.php

diff --git a/includes/registration/ExtensionJsonValidator.php b/includes/registration/ExtensionJsonValidator.php
index 564ea6b..ba5df52 100644 (file)
--- a/includes/registration/ExtensionJsonValidator.php
+++ b/includes/registration/ExtensionJsonValidator.php
@@ -21,8 +21,19 @@
 
 use Composer\Spdx\SpdxLicenses;
 use JsonSchema\Validator;
+use Seld\JsonLint\JsonParser;
+use Seld\JsonLint\ParsingException;
 
 /**
+ * Validate extension.json files against their JSON schema.
+ *
+ * This is used for static validation from the command-line via
+ * validateRegistrationFile.php, and the PHPUnit structure test suite
+ * (ExtensionJsonValidationTest).
+ *
+ * The files are normally read by the ExtensionRegistry
+ * and ExtensionProcessor classes.
+ *
  * @since 1.29
  */
 class ExtensionJsonValidator {
@@ -49,13 +60,21 @@ class ExtensionJsonValidator {
                                'The JsonSchema library cannot be found, please install it through composer.'
                        );
                        return false;
-               } elseif ( !class_exists( SpdxLicenses::class ) ) {
+               }
+
+               if ( !class_exists( SpdxLicenses::class ) ) {
                        call_user_func( $this->missingDepCallback,
                                'The spdx-licenses library cannot be found, please install it through composer.'
                        );
                        return false;
                }
 
+               if ( !class_exists( JsonParser::class ) ) {
+                       call_user_func( $this->missingDepCallback,
+                               'The JSON lint library cannot be found, please install it through composer.'
+                       );
+               }
+
                return true;
        }
 
@@ -65,8 +84,14 @@ class ExtensionJsonValidator {
         * @throws ExtensionJsonValidationError on any failure
         */
        public function validate( $path ) {
-               $data = json_decode( file_get_contents( $path ) );
-               if ( !is_object( $data ) ) {
+               $contents = file_get_contents( $path );
+               $jsonParser = new JsonParser();
+               try {
+                       $data = $jsonParser->parse( $contents, JsonParser::DETECT_KEY_CONFLICTS );
+               } catch ( ParsingException $e ) {
+                       if ( $e instanceof \Seld\JsonLint\DuplicateKeyException ) {
+                               throw new ExtensionJsonValidationError( $e->getMessage() );
+                       }
                        throw new ExtensionJsonValidationError( "$path is not valid JSON" );
                }
 
@@ -83,7 +108,9 @@ class ExtensionJsonValidator {
                        throw new ExtensionJsonValidationError(
                                "$path is using a non-supported schema version"
                        );
-               } elseif ( $version > ExtensionRegistry::MANIFEST_VERSION ) {
+               }
+
+               if ( $version > ExtensionRegistry::MANIFEST_VERSION ) {
                        throw new ExtensionJsonValidationError(
                                "$path is using a non-supported schema version"
                        );
@@ -119,15 +146,15 @@ class ExtensionJsonValidator {
                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 );
                }
+
+               $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 );
        }
 }