AbstractSchemaValidator.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\DB;
 
use JsonSchema\Validator;
use Seld\JsonLint\DuplicateKeyException;
use Seld\JsonLint\JsonParser;
use Seld\JsonLint\ParsingException;
use function class_exists;
use function file_get_contents;
use function is_array;
use function is_object;
 
class AbstractSchemaValidator {
    private $missingDepCallback;
 
    public function __construct( callable $missingDepCallback ) {
        $this->missingDepCallback = $missingDepCallback;
    }
 
    public function checkDependencies(): bool {
        if ( !class_exists( Validator::class ) ) {
            ( $this->missingDepCallback )(
                'The JsonSchema library cannot be found, please install it through composer.'
            );
            return false;
        }
 
        if ( !class_exists( JsonParser::class ) ) {
            ( $this->missingDepCallback )(
                'The JSON lint library cannot be found, please install it through composer.'
            );
            return false;
        }
 
        return true;
    }
 
    public function validate( string $path ): bool {
        $contents = file_get_contents( $path );
        $jsonParser = new JsonParser();
        try {
            $data = $jsonParser->parse( $contents, JsonParser::DETECT_KEY_CONFLICTS );
        } catch ( DuplicateKeyException $e ) {
            throw new AbstractSchemaValidationError( $e->getMessage(), $e->getCode(), $e );
        } catch ( ParsingException $e ) {
            throw new AbstractSchemaValidationError( "$path is not valid JSON", $e->getCode(), $e );
        }
 
        // Regular schema's are arrays, schema changes are objects.
        if ( is_array( $data ) ) {
            $schemaPath = __DIR__ . '/../../docs/abstract-schema.schema.json';
        } elseif ( is_object( $data ) ) {
            $schemaPath = __DIR__ . '/../../docs/abstract-schema-changes.schema.json';
        } else {
            throw new AbstractSchemaValidationError( "$path is not a supported JSON object" );
        }
 
        $validator = new Validator;
        $validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] );
        if ( $validator->isValid() ) {
            // All good.
            return true;
        }
 
        $out = "$path did not pass validation.\n";
        foreach ( $validator->getErrors() as $error ) {
            $out .= "[{$error['property']}] {$error['message']}\n";
        }
        throw new AbstractSchemaValidationError( $out );
    }
}