Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* SonarLint Core - Implementation
* Copyright (C) 2016-2021 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonarsource.sonarlint.core.plugin;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import org.sonar.api.utils.System2;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.api.utils.log.Profiler;
import org.sonarsource.sonarlint.core.client.api.common.AbstractGlobalConfiguration;
import org.sonarsource.sonarlint.core.client.api.common.Language;
import org.sonarsource.sonarlint.core.client.api.common.SkipReason;
import org.sonarsource.sonarlint.core.client.api.common.SkipReason.UnsatisfiedRuntimeRequirement.RuntimeRequirement;
import org.sonarsource.sonarlint.core.client.api.common.Version;
import org.sonarsource.sonarlint.core.client.api.exceptions.StorageException;
import org.sonarsource.sonarlint.core.container.connected.validate.PluginVersionChecker;
import org.sonarsource.sonarlint.core.plugin.PluginIndex.PluginReference;
import org.sonarsource.sonarlint.core.plugin.PluginInfo.RequiredPlugin;
import org.sonarsource.sonarlint.core.plugin.cache.PluginCache;
public class PluginInfosLoader {
private static final String OLD_SONARTS_PLUGIN_KEY = "typescript";
private static final String IMPLEMENTED_SQ_API = "8.5";
private static final Logger LOG = Loggers.get(PluginInfosLoader.class);
private final PluginCache pluginCache;
private final PluginIndex pluginIndex;
private final PluginVersionChecker pluginVersionChecker;
private final System2 system2;
private final AbstractGlobalConfiguration globalConfiguration;
public PluginInfosLoader(PluginVersionChecker pluginVersionChecker, PluginCache pluginCache, PluginIndex pluginIndex, AbstractGlobalConfiguration globalConfiguration,
System2 system2) {
this.pluginVersionChecker = pluginVersionChecker;
this.pluginCache = pluginCache;
this.pluginIndex = pluginIndex;
this.globalConfiguration = globalConfiguration;
this.system2 = system2;
}
public Map load() {
return loadPlugins(pluginIndex.references());
}
private Map loadPlugins(List pluginReferences) {
Map infosByKey = new HashMap<>();
Profiler profiler = Profiler.create(LOG).startDebug("Load plugins");
for (PluginReference ref : pluginReferences) {
Path jarFilePath = getFromCache(ref);
PluginInfo info = PluginInfo.create(jarFilePath);
Boolean sonarLintSupported = info.isSonarLintSupported();
if (sonarLintSupported == null || !sonarLintSupported.booleanValue()) {
LOG.debug("Plugin '{}' is not compatible with SonarLint. Skip loading it.", info.getName());
continue;
}
checkIfSkippedAndPopulateReason(info);
infosByKey.put(info.getKey(), info);
}
for (PluginInfo info : infosByKey.values()) {
if (!info.isSkipped()) {
checkUnsatisfiedPluginDependency(info, infosByKey);
}
}
profiler.stopDebug();
return infosByKey;
}
private void checkIfSkippedAndPopulateReason(PluginInfo info) {
String pluginKey = info.getKey();
Set languages = Language.getLanguagesByPluginKey(pluginKey);
if (!languages.isEmpty() && globalConfiguration.getEnabledLanguages().stream().noneMatch(languages::contains)) {
if (languages.size() > 1) {
LOG.debug("Plugin '{}' is excluded because none of languages '{}' are enabled. Skip loading it.", info.getName(),
languages.stream().map(Language::toString).collect(Collectors.joining(",")));
} else {
LOG.debug("Plugin '{}' is excluded because language '{}' is not enabled. Skip loading it.", info.getName(),
languages.iterator().next());
}
info.setSkipReason(new SkipReason.LanguagesNotEnabled(languages));
return;
}
if (!info.isCompatibleWith(IMPLEMENTED_SQ_API)) {
LOG.debug("Plugin '{}' requires plugin API {} while SonarLint supports only up to {}. Skip loading it.", info.getName(), info.getMinimalSqVersion(), IMPLEMENTED_SQ_API);
info.setSkipReason(SkipReason.IncompatiblePluginApi.INSTANCE);
return;
}
String pluginMinVersion = pluginVersionChecker.getMinimumVersion(pluginKey);
if (pluginMinVersion != null && !pluginVersionChecker.isVersionSupported(pluginKey, info.getVersion())) {
LOG.debug("Plugin '{}' version '{}' is not supported (minimal version is '{}'). Skip loading it.", info.getName(), info.getVersion(), pluginMinVersion);
info.setSkipReason(new SkipReason.IncompatiblePluginVersion(pluginMinVersion));
return;
}
Version jreMinVersion = info.getJreMinVersion();
String javaSpecVersion = Objects.requireNonNull(system2.property("java.specification.version"), "Missing Java property 'java.specification.version'");
if (jreMinVersion != null) {
Version jreCurrentVersion = Version.create(javaSpecVersion);
if (!jreCurrentVersion.satisfiesMinRequirement(jreMinVersion)) {
LOG.debug("Plugin '{}' requires JRE {} while current is {}. Skip loading it.", info.getName(), jreMinVersion, jreCurrentVersion);
info.setSkipReason(
new SkipReason.UnsatisfiedRuntimeRequirement(RuntimeRequirement.JRE, jreCurrentVersion.toString(), jreMinVersion.toString()));
}
}
Version nodeMinVersion = info.getNodeJsMinVersion();
if (nodeMinVersion != null) {
Version nodeCurrentVersion = globalConfiguration.getNodeJsVersion();
if (nodeCurrentVersion == null) {
LOG.debug("Plugin '{}' requires Node.js {}. Skip loading it.", info.getName(), nodeMinVersion);
info.setSkipReason(new SkipReason.UnsatisfiedRuntimeRequirement(RuntimeRequirement.NODEJS, null, nodeMinVersion.toString()));
} else if (!nodeCurrentVersion.satisfiesMinRequirement(nodeMinVersion)) {
LOG.debug("Plugin '{}' requires Node.js {} while current is {}. Skip loading it.", info.getName(), nodeMinVersion, nodeCurrentVersion);
info.setSkipReason(new SkipReason.UnsatisfiedRuntimeRequirement(RuntimeRequirement.NODEJS, nodeCurrentVersion.toString(), nodeMinVersion.toString()));
}
}
}
private static void checkUnsatisfiedPluginDependency(PluginInfo info, Map infosByKey) {
for (RequiredPlugin required : info.getRequiredPlugins()) {
if ("license".equals(required.getKey())) {
continue;
}
if (Language.JS.getPluginKey().equals(info.getKey()) && OLD_SONARTS_PLUGIN_KEY.equals(required.getKey())) {
// Workaround for SLCORE-259
// This dependency was added to ease migration on SonarQube, but can be ignored on SonarLint
// Note: The dependency was removed in SonarJS 6.3 but we should still keep the workaround as long as we want to support older
// versions
continue;
}
PluginInfo depInfo = infosByKey.get(required.getKey());
// We could possibly have a problem with transitive dependencies, since we evaluate in no specific order.
// A -> B -> C
// If C is skipped, then B should be skipped, then A should be skipped
// If we evaluate A before B, then A might be wrongly included
// But I'm not aware of such case in real life.
if (depInfo == null || depInfo.isSkipped()) {
LOG.debug("Plugin '{}' dependency on '{}' is unsatisfied. Skip loading it.", info.getName(), required.getKey());
info.setSkipReason(new SkipReason.UnsatisfiedDependency(required.getKey()));
return;
}
}
String basePluginKey = info.getBasePlugin();
if (basePluginKey != null) {
PluginInfo baseInfo = infosByKey.get(basePluginKey);
if (baseInfo == null || baseInfo.isSkipped()) {
LOG.debug("Plugin '{}' dependency on '{}' is unsatisfied. Skip loading it.", info.getName(), basePluginKey);
info.setSkipReason(new SkipReason.UnsatisfiedDependency(basePluginKey));
}
}
}
private Path getFromCache(final PluginReference pluginReference) {
Path jar;
try {
jar = pluginCache.get(pluginReference.getFilename(), pluginReference.getHash());
} catch (StorageException e) {
throw e;
} catch (Exception e) {
throw new IllegalStateException("Fail to find plugin " + pluginReference.getFilename() + " in the cache", e);
}
if (jar == null) {
throw new StorageException("Couldn't find plugin '" + pluginReference.getFilename() + "' in the cache. Please update the binding", false);
}
return jar;
}
}
