/*
* Copyright 2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.plugin.use.internal;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.Maps;
import org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.Nullable;
import org.gradle.api.Transformer;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.Dependency;
import org.gradle.api.artifacts.dsl.RepositoryHandler;
import org.gradle.api.artifacts.repositories.MavenArtifactRepository;
import org.gradle.api.initialization.dsl.ScriptHandler;
import org.gradle.api.internal.initialization.ClassLoaderScope;
import org.gradle.api.internal.plugins.ClassloaderBackedPluginDescriptorLocator;
import org.gradle.api.internal.plugins.PluginDescriptorLocator;
import org.gradle.api.internal.plugins.PluginRegistry;
import org.gradle.api.plugins.InvalidPluginException;
import org.gradle.api.plugins.PluginAware;
import org.gradle.api.plugins.UnknownPluginException;
import org.gradle.api.specs.Spec;
import org.gradle.internal.classpath.ClassPath;
import org.gradle.internal.classpath.DefaultClassPath;
import org.gradle.internal.exceptions.LocationAwareException;
import org.gradle.plugin.use.resolve.internal.*;
import java.io.File;
import java.util.*;
import static org.gradle.util.CollectionUtils.*;
public class DefaultPluginRequestApplicator implements PluginRequestApplicator {
private final PluginRegistry pluginRegistry;
private final PluginResolver pluginResolver;
public DefaultPluginRequestApplicator(PluginRegistry pluginRegistry, PluginResolver pluginResolver) {
this.pluginRegistry = pluginRegistry;
this.pluginResolver = pluginResolver;
}
public void applyPlugins(Collection<? extends PluginRequest> requests, final ScriptHandler scriptHandler, @Nullable final PluginAware target, ClassLoaderScope classLoaderScope) {
if (requests.isEmpty()) {
defineScriptHandlerClassScope(scriptHandler, classLoaderScope);
return;
}
if (target == null) {
throw new IllegalStateException("Plugin target is 'null' and there are plugin requests");
}
final PluginResolutionApplicator resolutionApplicator = new PluginResolutionApplicator(target);
final PluginResolver effectivePluginResolver = wrapInNotInClasspathCheck(classLoaderScope);
List<Result> results = collect(requests, new Transformer<Result, PluginRequest>() {
public Result transform(PluginRequest request) {
return resolveToFoundResult(effectivePluginResolver, request);
}
});
ImmutableListMultimap<Boolean, Result> categorizedResults = groupBy(results, new Transformer<Boolean, Result>() {
public Boolean transform(Result original) {
return original.legacyFound != null;
}
});
final List<Result> legacy = categorizedResults.get(true);
List<Result> nonLegacy = categorizedResults.get(false);
// Could be different to ids in the requests as they may be unqualified
final Map<Result, String> legacyActualPluginIds = Maps.newLinkedHashMap();
if (!legacy.isEmpty()) {
final RepositoryHandler repositories = scriptHandler.getRepositories();
final List<MavenArtifactRepository> mavenRepos = repositories.withType(MavenArtifactRepository.class);
for (final Result result : legacy) {
result.legacyFound.action.execute(new LegacyPluginResolveContext() {
public Dependency add(String pluginId, final String m2RepoUrl, Object dependencyNotation) {
legacyActualPluginIds.put(result, pluginId);
boolean repoExists = any(mavenRepos, new Spec<MavenArtifactRepository>() {
public boolean isSatisfiedBy(MavenArtifactRepository element) {
return element.getUrl().toString().equals(m2RepoUrl);
}
});
if (!repoExists) {
repositories.maven(new Action<MavenArtifactRepository>() {
public void execute(MavenArtifactRepository mavenArtifactRepository) {
mavenArtifactRepository.setUrl(m2RepoUrl);
}
});
}
return scriptHandler.getDependencies().add(ScriptHandler.CLASSPATH_CONFIGURATION, dependencyNotation);
}
});
}
}
defineScriptHandlerClassScope(scriptHandler, classLoaderScope);
// We're making an assumption here that the target's plugin registry is backed classLoaderScope.
// Because we are only build.gradle files right now, this holds.
// It won't for arbitrary scripts though.
for (final Map.Entry<Result, String> entry : legacyActualPluginIds.entrySet()) {
final PluginRequest request = entry.getKey().request;
final String id = entry.getValue();
applyPlugin(request, id, new Runnable() {
public void run() {
target.apply(Collections.singletonMap("plugin", id));
}
});
}
for (final Result result : nonLegacy) {
applyPlugin(result.request, result.found.resolution.getPluginId().toString(), new Runnable() {
public void run() {
resolutionApplicator.execute(result.found.resolution);
}
});
}
}
private void defineScriptHandlerClassScope(ScriptHandler scriptHandler, ClassLoaderScope classLoaderScope) {
Configuration classpathConfiguration = scriptHandler.getConfigurations().getByName(ScriptHandler.CLASSPATH_CONFIGURATION);
Set<File> files = classpathConfiguration.getFiles();
ClassPath classPath = new DefaultClassPath(files);
classLoaderScope.export(classPath);
classLoaderScope.lock();
}
private PluginResolver wrapInNotInClasspathCheck(ClassLoaderScope classLoaderScope) {
PluginDescriptorLocator scriptClasspathPluginDescriptorLocator = new ClassloaderBackedPluginDescriptorLocator(classLoaderScope.getParent().getExportClassLoader());
return new NotNonCorePluginOnClasspathCheckPluginResolver(pluginResolver, pluginRegistry, scriptClasspathPluginDescriptorLocator);
}
private void applyPlugin(PluginRequest request, String id, Runnable applicator) {
try {
try {
applicator.run();
} catch (UnknownPluginException e) {
throw new InvalidPluginException(
String.format(
"Could not apply requested plugin %s as it does not provide a plugin with id '%s'."
+ " This is caused by an incorrect plugin implementation."
+ " Please contact the plugin author(s).",
request, id
),
e
);
} catch (Exception e) {
throw new InvalidPluginException(String.format("An exception occurred applying plugin request %s", request), e);
}
} catch (Exception e) {
throw new LocationAwareException(e, request.getScriptSource(), request.getLineNumber());
}
}
private Result resolveToFoundResult(PluginResolver effectivePluginResolver, PluginRequest request) {
Result result = new Result(request);
try {
effectivePluginResolver.resolve(request, result);
} catch (Exception e) {
throw new LocationAwareException(
new GradleException(String.format("Error resolving plugin %s", request.getDisplayName()), e),
request.getScriptSource(), request.getLineNumber());
}
if (!result.isFound()) {
String message = buildNotFoundMessage(request, result);
Exception exception = new UnknownPluginException(message);
throw new LocationAwareException(exception, request.getScriptSource(), request.getLineNumber());
}
return result;
}
private String buildNotFoundMessage(PluginRequest pluginRequest, Result result) {
if (result.notFoundList.isEmpty()) {
// this shouldn't happen, resolvers should call notFound()
return String.format("Plugin %s was not found", pluginRequest.getDisplayName());
} else {
Formatter sb = new Formatter();
sb.format("Plugin %s was not found in any of the following sources:%n", pluginRequest.getDisplayName());
for (NotFound notFound : result.notFoundList) {
sb.format("%n- %s", notFound.source);
if (notFound.detail != null) {
sb.format(" (%s)", notFound.detail);
}
}
return sb.toString();
}
}
private static class NotFound {
private final String source;
private final String detail;
private NotFound(String source, String detail) {
this.source = source;
this.detail = detail;
}
}
private static class Found {
private final String source;
private final PluginResolution resolution;
private Found(String source, PluginResolution resolution) {
this.source = source;
this.resolution = resolution;
}
}
private static class LegacyFound {
private final String source;
private final Action<? super LegacyPluginResolveContext> action;
private LegacyFound(String source, Action<? super LegacyPluginResolveContext> action) {
this.source = source;
this.action = action;
}
}
private static class Result implements PluginResolutionResult {
private final List<NotFound> notFoundList = new LinkedList<NotFound>();
private final PluginRequest request;
private Found found;
private LegacyFound legacyFound;
public Result(PluginRequest request) {
this.request = request;
}
public void notFound(String sourceDescription, String notFoundDetail) {
notFoundList.add(new NotFound(sourceDescription, notFoundDetail));
}
public void found(String sourceDescription, PluginResolution pluginResolution) {
found = new Found(sourceDescription, pluginResolution);
}
public void foundLegacy(String sourceDescription, Action<? super LegacyPluginResolveContext> action) {
this.legacyFound = new LegacyFound(sourceDescription, action);
}
public boolean isFound() {
return found != null || legacyFound != null;
}
}
}