VersionChecker.php

Go to the documentation of this file.

<?php
use Composer\Semver\Constraint\Constraint;
use Composer\Semver\VersionParser;
 
class VersionChecker {
    private $coreVersion = false;
 
    private $phpVersion = false;
 
    private $phpExtensions;
 
    private $abilities;
 
    private $abilityErrors;
 
    private $loaded = [];
 
    private $versionParser;
 
    public function __construct(
        $coreVersion, $phpVersion, array $phpExtensions,
        array $abilities = [], array $abilityErrors = []
    ) {
        $this->versionParser = new VersionParser();
        $this->setCoreVersion( $coreVersion );
        $this->setPhpVersion( $phpVersion );
        $this->phpExtensions = $phpExtensions;
        $this->abilities = $abilities;
        $this->abilityErrors = $abilityErrors;
    }
 
    public function setLoadedExtensionsAndSkins( array $credits ) {
        $this->loaded = $credits;
 
        return $this;
    }
 
    private function setCoreVersion( $coreVersion ) {
        try {
            $this->coreVersion = new Constraint(
                '==',
                $this->versionParser->normalize( $coreVersion )
            );
            $this->coreVersion->setPrettyString( $coreVersion );
        } catch ( UnexpectedValueException $e ) {
            // Non-parsable version, don't fatal.
        }
    }
 
    private function setPhpVersion( $phpVersion ) {
        // normalize to make this throw an exception if the version is invalid
        $this->phpVersion = new Constraint(
            '==',
            $this->versionParser->normalize( $phpVersion )
        );
        $this->phpVersion->setPrettyString( $phpVersion );
    }
 
    public function checkArray( array $extDependencies ) {
        $errors = [];
        foreach ( $extDependencies as $extension => $dependencies ) {
            foreach ( $dependencies as $dependencyType => $values ) {
                switch ( $dependencyType ) {
                    case ExtensionRegistry::MEDIAWIKI_CORE:
                        $mwError = $this->handleDependency(
                            $this->coreVersion,
                            $values
                        );
                        if ( $mwError !== false ) {
                            $errors[] = [
                                'msg' =>
                                    "{$extension} is not compatible with the current MediaWiki "
                                    . "core (version {$this->coreVersion->getPrettyString()}), "
                                    . "it requires: $values.",
                                'type' => 'incompatible-core',
                            ];
                        }
                        break;
                    case 'platform':
                        foreach ( $values as $dependency => $constraint ) {
                            if ( $dependency === 'php' ) {
                                // PHP version
                                $phpError = $this->handleDependency(
                                    $this->phpVersion,
                                    $constraint
                                );
                                if ( $phpError !== false ) {
                                    $errors[] = [
                                        'msg' =>
                                            "{$extension} is not compatible with the current PHP "
                                            . "version {$this->phpVersion->getPrettyString()}), "
                                            . "it requires: $constraint.",
                                        'type' => 'incompatible-php',
                                    ];
                                }
                            } elseif ( substr( $dependency, 0, 4 ) === 'ext-' ) {
                                // PHP extensions
                                $phpExtension = substr( $dependency, 4 );
                                if ( $constraint !== '*' ) {
                                    throw new UnexpectedValueException( 'Version constraints for '
                                        . 'PHP extensions are not supported in ' . $extension );
                                }
                                if ( !in_array( $phpExtension, $this->phpExtensions, true ) ) {
                                    $errors[] = [
                                        'msg' =>
                                            "{$extension} requires {$phpExtension} PHP extension "
                                            . "to be installed.",
                                        'type' => 'missing-phpExtension',
                                        'missing' => $phpExtension,
                                    ];
                                }
                            } elseif ( substr( $dependency, 0, 8 ) === 'ability-' ) {
                                // Other abilities the environment might provide.
                                $ability = substr( $dependency, 8 );
                                if ( !isset( $this->abilities[$ability] ) ) {
                                    throw new UnexpectedValueException( 'Dependency type '
                                    . $dependency . ' unknown in ' . $extension );
                                }
                                if ( !is_bool( $constraint ) ) {
                                    throw new UnexpectedValueException( 'Only booleans are '
                                        . 'allowed to to indicate the presence of abilities '
                                        . 'in ' . $extension );
                                }
 
                                if ( $constraint &&
                                    $this->abilities[$ability] !== true
                                ) {
                                    // add custom error message for missing ability if specified
                                    $customMessage = '';
                                    if ( isset( $this->abilityErrors[$ability] ) ) {
                                        $customMessage = ': ' . $this->abilityErrors[$ability];
                                    }
 
                                    $errors[] = [
                                        'msg' =>
                                            "{$extension} requires \"{$ability}\" ability"
                                            . $customMessage,
                                        'type' => 'missing-ability',
                                        'missing' => $ability,
                                    ];
                                }
                            } else {
                                // add other platform dependencies here
                                throw new UnexpectedValueException( 'Dependency type ' . $dependency .
                                    ' unknown in ' . $extension );
                            }
                        }
                        break;
                    case 'extensions':
                    case 'skins':
                        foreach ( $values as $dependency => $constraint ) {
                            $extError = $this->handleExtensionDependency(
                                $dependency, $constraint, $extension, $dependencyType
                            );
                            if ( $extError !== false ) {
                                $errors[] = $extError;
                            }
                        }
                        break;
                    default:
                        throw new UnexpectedValueException( 'Dependency type ' . $dependencyType .
                            ' unknown in ' . $extension );
                }
            }
        }
 
        return $errors;
    }
 
    private function handleDependency( $version, $constraint ) {
        if ( $version === false ) {
            // Couldn't parse the version, so we can't check anything
            return false;
        }
 
        // if the installed and required version are compatible, return an empty array
        if ( $this->versionParser->parseConstraints( $constraint )
            ->matches( $version ) ) {
            return false;
        }
 
        return true;
    }
 
    private function handleExtensionDependency( $dependencyName, $constraint, $checkedExt,
        $type
    ) {
        // Check if the dependency is even installed
        if ( !isset( $this->loaded[$dependencyName] ) ) {
            return [
                'msg' => "{$checkedExt} requires {$dependencyName} to be installed.",
                'type' => "missing-$type",
                'missing' => $dependencyName,
            ];
        }
        if ( $constraint === '*' ) {
            // short-circuit since any version is OK.
            return false;
        }
        // Check if the dependency has specified a version
        if ( !isset( $this->loaded[$dependencyName]['version'] ) ) {
            $msg = "{$dependencyName} does not expose its version, but {$checkedExt}"
                . " requires: {$constraint}.";
            return [
                'msg' => $msg,
                'type' => "incompatible-$type",
                'incompatible' => $checkedExt,
            ];
        } else {
            // Try to get a constraint for the dependency version
            try {
                $installedVersion = new Constraint(
                    '==',
                    $this->versionParser->normalize( $this->loaded[$dependencyName]['version'] )
                );
            } catch ( UnexpectedValueException $e ) {
                // Non-parsable version, output an error message that the version
                // string is invalid
                return [
                    'msg' => "$dependencyName does not have a valid version string.",
                    'type' => 'invalid-version',
                ];
            }
            // Check if the constraint actually matches...
            if (
                !$this->versionParser->parseConstraints( $constraint )->matches( $installedVersion )
            ) {
                $msg = "{$checkedExt} is not compatible with the current "
                    . "installed version of {$dependencyName} "
                    . "({$this->loaded[$dependencyName]['version']}), "
                    . "it requires: " . $constraint . '.';
                return [
                    'msg' => $msg,
                    'type' => "incompatible-$type",
                    'incompatible' => $checkedExt,
                ];
            }
        }
 
        return false;
    }
}