org.sonarsource.sonarlint.core.storage.PluginsStorage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation
Common library used by some SonarLint flavors
There is a newer version: 10.1.0.77731
/*
 * SonarLint Core - Implementation
 * Copyright (C) 2016-2022 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.storage;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.io.FileUtils;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonarsource.sonarlint.core.client.api.exceptions.StorageException;
import org.sonarsource.sonarlint.core.container.storage.ProtobufUtil;
import org.sonarsource.sonarlint.core.container.storage.RWLock;
import org.sonarsource.sonarlint.core.proto.Sonarlint;
import org.sonarsource.sonarlint.core.serverapi.plugins.ServerPlugin;

public class PluginsStorage {
  private static final Logger LOG = Loggers.get(PluginsStorage.class);
  public static final String PLUGIN_REFERENCES_PB = "plugin_references.pb";

  private final Path rootPath;
  private final RWLock rwLock = new RWLock();

  public PluginsStorage(Path rootPath) {
    this.rootPath = rootPath;
  }

  public void store(ServerPlugin plugin, InputStream pluginBinary) {
    try {
      FileUtils.copyInputStreamToFile(pluginBinary, rootPath.resolve(plugin.getFilename()).toFile());
      var reference = adapt(plugin);
      rwLock.write(() -> {
        var pluginsFilePath = getPluginsFilePath();
        var references = Files.exists(pluginsFilePath) ? ProtobufUtil.readFile(pluginsFilePath, Sonarlint.PluginReferences.parser())
          : Sonarlint.PluginReferences.newBuilder().build();
        var currentReferences = Sonarlint.PluginReferences.newBuilder(references);
        currentReferences.putPluginsByKey(plugin.getKey(), reference);
        ProtobufUtil.writeToFile(currentReferences.build(), pluginsFilePath);
      });
    } catch (IOException e) {
      // XXX should we stop the whole sync ? just continue and log ?
      throw new StorageException("Cannot save plugin " + plugin.getFilename() + " in " + rootPath, e);
    }
  }

  public List getStoredPlugins() {
    var filePath = getPluginsFilePath();
    return rwLock.read(() -> Files.exists(filePath) ? ProtobufUtil.readFile(filePath, Sonarlint.PluginReferences.parser()) : Sonarlint.PluginReferences.newBuilder().build())
      .getPluginsByKeyMap().values().stream().map(this::adapt).collect(Collectors.toList());
  }

  private Path getPluginsFilePath() {
    return rootPath.resolve(PLUGIN_REFERENCES_PB);
  }

  public Map getStoredPluginsByKey() {
    return byKey(getStoredPlugins());
  }

  public Map getStoredPluginPathsByKey() {
    return byKey(getStoredPlugins()).entrySet().stream().collect(Collectors.toMap(Map.Entry::getKey, v -> v.getValue().getJarPath()));
  }

  private static Map byKey(List plugins) {
    return plugins.stream().collect(Collectors.toMap(StoredPlugin::getKey, Function.identity()));
  }

  private static Sonarlint.PluginReferences.PluginReference adapt(ServerPlugin plugin) {
    return Sonarlint.PluginReferences.PluginReference.newBuilder()
      .setKey(plugin.getKey())
      .setHash(plugin.getHash())
      .setFilename(plugin.getFilename())
      .build();
  }

  private StoredPlugin adapt(Sonarlint.PluginReferences.PluginReference plugin) {
    return new StoredPlugin(
      plugin.getKey(),
      plugin.getHash(),
      rootPath.resolve(plugin.getFilename()));
  }

  public void cleanUp() {
    getUnknownFiles()
      .forEach(FileUtils::deleteQuietly);
  }

  private List getUnknownFiles() {
    if (!Files.exists(rootPath)) {
      return Collections.emptyList();
    }
    var knownPluginsPaths = getStoredPlugins().stream().map(StoredPlugin::getJarPath).collect(Collectors.toSet());
    try (Stream pathsInDir = Files.list(rootPath)) {
      return pathsInDir.filter(p -> !p.equals(getPluginsFilePath()))
        .filter(p -> !knownPluginsPaths.contains(p))
        .map(Path::toFile)
        .collect(Collectors.toList());
    } catch (Exception e) {
      LOG.error("Cannot list files in '{}'", rootPath, e);
      return Collections.emptyList();
    }
  }
}