mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-11-13 17:05:43 +01:00
273 lines
9.4 KiB
Java
273 lines
9.4 KiB
Java
/**
|
|
* Copyright (c) 2010, Sebastian Sdorra
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* 3. Neither the name of SCM-Manager; nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
|
|
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* http://bitbucket.org/sdorra/scm-manager
|
|
*
|
|
*/
|
|
|
|
|
|
|
|
package sonia.scm.plugin;
|
|
|
|
import com.google.common.annotations.VisibleForTesting;
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.inject.Singleton;
|
|
import org.slf4j.Logger;
|
|
import org.slf4j.LoggerFactory;
|
|
import sonia.scm.NotFoundException;
|
|
import sonia.scm.event.ScmEventBus;
|
|
import sonia.scm.lifecycle.RestartEvent;
|
|
import sonia.scm.version.Version;
|
|
|
|
import javax.inject.Inject;
|
|
import java.io.IOException;
|
|
import java.nio.file.Files;
|
|
import java.util.ArrayList;
|
|
import java.util.Collection;
|
|
import java.util.List;
|
|
import java.util.Optional;
|
|
import java.util.Set;
|
|
import java.util.function.Predicate;
|
|
import java.util.stream.Collectors;
|
|
|
|
import static sonia.scm.ContextEntry.ContextBuilder.entity;
|
|
import static sonia.scm.ScmConstraintViolationException.Builder.doThrow;
|
|
|
|
//~--- JDK imports ------------------------------------------------------------
|
|
|
|
/**
|
|
*
|
|
* @author Sebastian Sdorra
|
|
*/
|
|
@Singleton
|
|
public class DefaultPluginManager implements PluginManager {
|
|
|
|
private static final Logger LOG = LoggerFactory.getLogger(DefaultPluginManager.class);
|
|
|
|
private final ScmEventBus eventBus;
|
|
private final PluginLoader loader;
|
|
private final PluginCenter center;
|
|
private final PluginInstaller installer;
|
|
private final Collection<PendingPluginInstallation> pendingQueue = new ArrayList<>();
|
|
private final PluginDependencyTracker dependencyTracker = new PluginDependencyTracker();
|
|
|
|
@Inject
|
|
public DefaultPluginManager(ScmEventBus eventBus, PluginLoader loader, PluginCenter center, PluginInstaller installer) {
|
|
this.eventBus = eventBus;
|
|
this.loader = loader;
|
|
this.center = center;
|
|
this.installer = installer;
|
|
|
|
this.computeInstallationDependencies();
|
|
}
|
|
|
|
@VisibleForTesting
|
|
synchronized void computeInstallationDependencies() {
|
|
loader.getInstalledPlugins()
|
|
.stream()
|
|
.map(InstalledPlugin::getDescriptor)
|
|
.forEach(dependencyTracker::addInstalled);
|
|
updateMayUninstallFlag();
|
|
}
|
|
|
|
@Override
|
|
public Optional<AvailablePlugin> getAvailable(String name) {
|
|
PluginPermissions.read().check();
|
|
return center.getAvailable()
|
|
.stream()
|
|
.filter(filterByName(name))
|
|
.filter(this::isNotInstalledOrMoreUpToDate)
|
|
.map(p -> getPending(name).orElse(p))
|
|
.findFirst();
|
|
}
|
|
|
|
private Optional<AvailablePlugin> getPending(String name) {
|
|
return pendingQueue
|
|
.stream()
|
|
.map(PendingPluginInstallation::getPlugin)
|
|
.filter(filterByName(name))
|
|
.findFirst();
|
|
}
|
|
|
|
@Override
|
|
public Optional<InstalledPlugin> getInstalled(String name) {
|
|
PluginPermissions.read().check();
|
|
return loader.getInstalledPlugins()
|
|
.stream()
|
|
.filter(filterByName(name))
|
|
.findFirst();
|
|
}
|
|
|
|
@Override
|
|
public List<InstalledPlugin> getInstalled() {
|
|
PluginPermissions.read().check();
|
|
return ImmutableList.copyOf(loader.getInstalledPlugins());
|
|
}
|
|
|
|
@Override
|
|
public List<AvailablePlugin> getAvailable() {
|
|
PluginPermissions.read().check();
|
|
return center.getAvailable()
|
|
.stream()
|
|
.filter(this::isNotInstalledOrMoreUpToDate)
|
|
.map(p -> getPending(p.getDescriptor().getInformation().getName()).orElse(p))
|
|
.collect(Collectors.toList());
|
|
}
|
|
|
|
private <T extends Plugin> Predicate<T> filterByName(String name) {
|
|
return plugin -> name.equals(plugin.getDescriptor().getInformation().getName());
|
|
}
|
|
|
|
private boolean isNotInstalledOrMoreUpToDate(AvailablePlugin availablePlugin) {
|
|
return getInstalled(availablePlugin.getDescriptor().getInformation().getName())
|
|
.map(installedPlugin -> availableIsMoreUpToDateThanInstalled(availablePlugin, installedPlugin))
|
|
.orElse(true);
|
|
}
|
|
|
|
private boolean availableIsMoreUpToDateThanInstalled(AvailablePlugin availablePlugin, InstalledPlugin installed) {
|
|
return Version.parse(availablePlugin.getDescriptor().getInformation().getVersion()).isNewer(installed.getDescriptor().getInformation().getVersion());
|
|
}
|
|
|
|
@Override
|
|
public void install(String name, boolean restartAfterInstallation) {
|
|
PluginPermissions.manage().check();
|
|
|
|
getInstalled(name)
|
|
.map(InstalledPlugin::isCore)
|
|
.ifPresent(
|
|
core -> doThrow().violation("plugin is a core plugin and cannot be updated").when(core)
|
|
);
|
|
|
|
List<AvailablePlugin> plugins = collectPluginsToInstall(name);
|
|
List<PendingPluginInstallation> pendingInstallations = new ArrayList<>();
|
|
for (AvailablePlugin plugin : plugins) {
|
|
try {
|
|
PendingPluginInstallation pending = installer.install(plugin);
|
|
dependencyTracker.addInstalled(plugin.getDescriptor());
|
|
pendingInstallations.add(pending);
|
|
} catch (PluginInstallException ex) {
|
|
cancelPending(pendingInstallations);
|
|
throw ex;
|
|
}
|
|
}
|
|
|
|
if (!pendingInstallations.isEmpty()) {
|
|
if (restartAfterInstallation) {
|
|
restart("plugin installation");
|
|
} else {
|
|
pendingQueue.addAll(pendingInstallations);
|
|
updateMayUninstallFlag();
|
|
}
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void uninstall(String name, boolean restartAfterInstallation) {
|
|
PluginPermissions.manage().check();
|
|
InstalledPlugin installed = getInstalled(name)
|
|
.orElseThrow(() -> NotFoundException.notFound(entity(InstalledPlugin.class, name)));
|
|
doThrow().violation("plugin is a core plugin and cannot be uninstalled").when(installed.isCore());
|
|
|
|
dependencyTracker.removeInstalled(installed.getDescriptor());
|
|
installed.setMarkedForUninstall(true);
|
|
|
|
createMarkerFile(installed, InstalledPlugin.UNINSTALL_MARKER_FILENAME);
|
|
|
|
if (restartAfterInstallation) {
|
|
restart("plugin installation");
|
|
} else {
|
|
updateMayUninstallFlag();
|
|
}
|
|
}
|
|
|
|
private void updateMayUninstallFlag() {
|
|
loader.getInstalledPlugins()
|
|
.forEach(p -> p.setUninstallable(isUninstallable(p)));
|
|
}
|
|
|
|
private boolean isUninstallable(InstalledPlugin p) {
|
|
return !p.isCore()
|
|
&& !p.isMarkedForUninstall()
|
|
&& dependencyTracker.mayUninstall(p.getDescriptor().getInformation().getName());
|
|
}
|
|
|
|
private void createMarkerFile(InstalledPlugin plugin, String markerFile) {
|
|
try {
|
|
Files.createFile(plugin.getDirectory().resolve(markerFile));
|
|
} catch (IOException e) {
|
|
throw new PluginException("could not mark plugin " + plugin.getId() + " in path " + plugin.getDirectory() + "as " + markerFile, e);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void executePendingAndRestart() {
|
|
PluginPermissions.manage().check();
|
|
if (!pendingQueue.isEmpty() || getInstalled().stream().anyMatch(InstalledPlugin::isMarkedForUninstall)) {
|
|
restart("execute pending plugin changes");
|
|
}
|
|
}
|
|
|
|
private void restart(String cause) {
|
|
eventBus.post(new RestartEvent(PluginManager.class, cause));
|
|
}
|
|
|
|
private void cancelPending(List<PendingPluginInstallation> pendingInstallations) {
|
|
pendingInstallations.forEach(PendingPluginInstallation::cancel);
|
|
}
|
|
|
|
private List<AvailablePlugin> collectPluginsToInstall(String name) {
|
|
List<AvailablePlugin> plugins = new ArrayList<>();
|
|
collectPluginsToInstall(plugins, name, true);
|
|
return plugins;
|
|
}
|
|
|
|
private void collectPluginsToInstall(List<AvailablePlugin> plugins, String name, boolean isUpdate) {
|
|
if (!isInstalledOrPending(name) || isUpdate && isUpdatable(name)) {
|
|
AvailablePlugin plugin = getAvailable(name).orElseThrow(() -> NotFoundException.notFound(entity(AvailablePlugin.class, name)));
|
|
|
|
Set<String> dependencies = plugin.getDescriptor().getDependencies();
|
|
if (dependencies != null) {
|
|
for (String dependency: dependencies){
|
|
collectPluginsToInstall(plugins, dependency, false);
|
|
}
|
|
}
|
|
|
|
plugins.add(plugin);
|
|
} else {
|
|
LOG.info("plugin {} is already installed or installation is pending, skipping installation", name);
|
|
}
|
|
}
|
|
|
|
private boolean isInstalledOrPending(String name) {
|
|
return getInstalled(name).isPresent() || getPending(name).isPresent();
|
|
}
|
|
|
|
private boolean isUpdatable(String name) {
|
|
return getAvailable(name).isPresent() && !getPending(name).isPresent();
|
|
}
|
|
}
|