1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugin;
use Composer\Semver\VersionParser;
use Piwik\Plugin\Manager as PluginManager;
use Piwik\Plugins\Marketplace\Environment;
use Piwik\Version;
/**
*
*/
class Dependency
{
private $piwikVersion;
private $phpVersion;
public function __construct()
{
$this->setPiwikVersion(Version::VERSION);
$this->setPhpVersion(PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION . '.' . PHP_RELEASE_VERSION);
}
public function setEnvironment(Environment $environment)
{
$this->setPiwikVersion($environment->getPiwikVersion());
$this->setPhpVersion($environment->getPhpVersion());
}
public function getMissingDependencies($requires)
{
$missingRequirements = array();
if (empty($requires)) {
return $missingRequirements;
}
foreach ($requires as $name => $requiredVersion) {
$currentVersion = $this->getCurrentVersion($name);
if (in_array(strtolower($name), ['piwik', 'matomo'])) {
$requiredVersion = $this->markPluginsWithoutUpperBoundMatomoRequirementAsIncompatible($requiredVersion);
}
$missingVersions = $this->getMissingVersions($currentVersion, $requiredVersion);
if (!empty($missingVersions)) {
$missingRequirements[] = array(
'requirement' => $name,
'actualVersion' => $currentVersion,
'requiredVersion' => $requiredVersion,
'causedBy' => implode(', ', $missingVersions),
);
}
}
return $missingRequirements;
}
public function getMissingVersions($currentVersion, $requiredVersion)
{
$currentVersion = trim($currentVersion ?? '');
$missingVersions = array();
if (empty($currentVersion)) {
if (!empty($requiredVersion)) {
$missingVersions[] = (string) $requiredVersion;
}
return $missingVersions;
}
$requiredVersion = $this->makeVersionBackwardsCompatibleIfNoComparisonDefined($requiredVersion);
$version = new VersionParser();
$constraintsExisting = $version->parseConstraints($currentVersion);
$requiredVersions = explode(',', (string) $requiredVersion);
foreach ($requiredVersions as $required) {
$required = trim($required);
if (empty($required)) {
continue;
}
$required = $this->makeVersionBackwardsCompatibleIfNoComparisonDefined($required);
$constraintRequired = $version->parseConstraints($required);
if (!$constraintRequired->matches($constraintsExisting)) {
$missingVersions[] = $required;
}
}
return $missingVersions;
}
/**
* Upon Matomo 4 we require a lower and upper version bound for Matomo to be set in plugin.json
* If that is not the case we assume the plugin not to be compatible with Matomo 4
*
* @param string $requiredVersion
* @return string
*/
private function markPluginsWithoutUpperBoundMatomoRequirementAsIncompatible($requiredVersion)
{
if (strpos($requiredVersion, ',') !== false) {
return $requiredVersion;
}
$minVersion = str_replace(array('>', '=', '<', '!', '~', '^'), '', $requiredVersion);
if (preg_match("/^\<=?\d/", $requiredVersion)) {
$upperLimit = '>=' . $minVersion[0] . '.0.0-b1,' . $requiredVersion;
} elseif (!empty($minVersion) && is_numeric($minVersion[0])) {
$upperLimit = $requiredVersion . ',<' . ($minVersion[0] + 1) . '.0.0-b1';
} else {
$upperLimit = '>=4.0.0-b1,<5.0.0-b1';
}
return $upperLimit;
}
private function makeVersionBackwardsCompatibleIfNoComparisonDefined($version)
{
if (!empty($version) && preg_match('/^(\d+)\.(\d+)/', $version)) {
// TODO: we should remove this from piwik 3. To stay BC we add >= if no >= is defined yet
$version = '>=' . $version;
}
return $version;
}
public function setPiwikVersion($piwikVersion)
{
$this->piwikVersion = $piwikVersion;
}
public function setPhpVersion($phpVersion)
{
$this->phpVersion = $phpVersion;
}
public function hasDependencyToDisabledPlugin($requires)
{
if (empty($requires)) {
return false;
}
foreach ($requires as $name => $requiredVersion) {
$nameLower = strtolower($name);
$isPluginRequire = !in_array($nameLower, array('piwik', 'php', 'matomo'));
if ($isPluginRequire) {
// we do not check version, only whether it's activated. Everything that is not piwik or php is assumed
// a plugin so far.
if (!PluginManager::getInstance()->isPluginActivated($name)) {
return true;
}
}
}
return false;
}
private function getCurrentVersion($name)
{
switch (strtolower($name)) {
case 'matomo':
case 'piwik':
return $this->piwikVersion;
case 'php':
return $this->phpVersion;
default:
try {
$pluginNames = PluginManager::getAllPluginsNames();
if (!in_array($name, $pluginNames) || !PluginManager::getInstance()->isPluginLoaded($name)) {
return '';
}
$plugin = PluginManager::getInstance()->loadPlugin(ucfirst($name));
if (!empty($plugin)) {
return $plugin->getVersion();
}
} catch (\Exception $e) {
}
}
return '';
}
}
|