Composer.php

Go to the documentation of this file.

<?php
namespace Elgg\Plugin;

use Elgg\Exceptions\Plugin\IdMismatchException;
use Elgg\Exceptions\Plugin\ComposerException;
use Elgg\Exceptions\Plugin\ConflictException;
use Composer\Semver\Semver;
use Elgg\Exceptions\Plugin\PhpVersionException;
use Elgg\Exceptions\Plugin\PhpExtensionException;

class Composer {
    
    protected $plugin;
    
    protected $configuration;
    
    public function __construct(\ElggPlugin $plugin) {
        $this->plugin = $plugin;
        
        try {
            // need to suppress warning because of deprecated notices that get converted to warnings during phpunit
            $reader = @new \Eloquent\Composer\Configuration\ConfigurationReader;
            $this->configuration = $reader->read($this->plugin->getPath() . 'composer.json');
        } catch (\Exception $e) {
            throw new ComposerException(elgg_echo('ElggPlugin:NoPluginComposer', [
                $this->plugin->getID(),
                $this->plugin->guid,
            ]));
        }
    }
    
    public function getConfiguration() {
        return $this->configuration;
    }
    
    public function assertPluginId() {
        if ($this->configuration->projectName() !== $this->plugin->getID()) {
            throw new IdMismatchException(elgg_echo('ElggPlugin:IdMismatch', [$this->configuration->projectName()]));
        }
    }
    
    public function getLicense() {
        $license = $this->configuration->license();
        if (!empty($license)) {
            $license = implode(', ', $license);
        }
        
        return (string) $license;
    }
    
    public function getCategories() {
        $cats = $this->configuration->keywords() ?: [];
        
        $result = [];
        foreach ($cats as $cat) {
            $result[strtolower($cat)] = $this->getFriendlyCategory($cat);
        }
        
        // plugins often set Elgg in their keywords, we do not need that keyword
        unset($result['elgg']);
        unset($result['plugin']);
        
        // add vendor to categories
        $vendor = strtolower((string) $this->configuration->vendorName());
        if (!isset($result[$vendor])) {
            $result[$vendor] = $this->getFriendlyCategory($vendor);
        }
                
        return $result;
    }
    
    public function getConflicts() {
        $conflicts = $this->configuration->conflict();
        
        $result = [];
        foreach ($conflicts as $name => $version) {
            list(,$projectname) = explode('/', $name);
            if (!empty($projectname)) {
                $result[$projectname] = $version;
            }
        }
        
        return $result;
    }
    
    public function assertConflicts() {
        $conflicts = $this->getConflicts();
        if (empty($conflicts)) {
            return;
        }
        
        if (isset($conflicts['elgg'])) {
            if ($this->checkConstraints(elgg_get_release(), $conflicts['elgg'])) {
                throw new ConflictException('Elgg version: ' . elgg_get_release() . ' conflicts with constraint '. $conflicts['elgg']);
            }
            
            unset($conflicts['elgg']);
        }
        
        foreach ($conflicts as $plugin_id => $constraints) {
            if (!elgg_is_active_plugin($plugin_id)) {
                continue;
            }
            
            $plugin = elgg_get_plugin_from_id($plugin_id);
            
            if ($this->checkConstraints($plugin->getVersion(), $constraints)) {
                throw new ConflictException("Plugin [{$plugin->getID()}] with version: {$plugin->getVersion()} conflicts with constraint {$constraints}");
            }
        }
    }
    
    public function assertActivePluginConflicts() {
        $active_plugins = elgg_get_plugins('active');
        foreach ($active_plugins as $plugin) {
            $conflicts = $plugin->getConflicts();
            if (!isset($conflicts[$this->plugin->getID()])) {
                continue;
            }
            
            $constraint = $conflicts[$this->plugin->getID()];
            if ($this->checkConstraints($this->plugin->getVersion(), $constraint)) {
                $msg = 'The plugin ' . $this->plugin->getDisplayName() . ' with version ' . $this->plugin->getVersion();
                $msg .= ' conflicts with constraint '. $constraint . ' defined in ' . $plugin->getID();
                throw new ConflictException($msg);
            }
        }
    }
    
    public function checkConstraints($version, $constraints) {
        try {
            return Semver::satisfies($version, $constraints);
        } catch (\UnexpectedValueException $e) {
            // something is wrong with the version number
            elgg_log($e, 'ERROR');
        }
        
        return false;
    }
    
    public function assertRequiredPhpVersion() {
        $requirements = $this->configuration->dependencies();
        if (!isset($requirements['php'])) {
            return;
        }
        
        $php_version = phpversion();
        if (!$this->checkConstraints($php_version, $requirements['php'])) {
            throw new PhpVersionException("The PHP version ({$php_version}) does not meet the plugin [{$this->plugin->getID()}] requirements of {$requirements['php']}");
        }
    }
    
    public function assertRequiredPhpExtensions() {
        $requirements = $this->configuration->dependencies();
        foreach ($requirements as $name => $constraint) {
            if (!str_starts_with($name, 'ext-')) {
                continue;
            }
            
            $extension = substr($name, 4);
            if (!extension_loaded($extension)) {
                throw new PhpExtensionException("Plugin [{$this->plugin->getID()}] requires the PHP extensions {$extension}");
            }
            
            $extension_version = phpversion($extension);
            if (!$this->checkConstraints($extension_version, $constraint)) {
                throw new PhpExtensionException("The PHP extension version ({$extension_version}) does not meet the plugin [{$this->plugin->getID()}] requirements of {$constraint}");
            }
        }
    }
    
    protected function getFriendlyCategory($category) {
        $cat_raw_string = strtolower("admin:plugins:category:{$category}");
        if (_elgg_services()->translator->languageKeyExists($cat_raw_string)) {
            return elgg_echo($cat_raw_string);
        }
        
        return ucwords(str_replace(['-', '_'], ' ', $category));
    }
}