DefaultProjectBuilder.java
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.maven.internal.impl;
import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.Path;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import org.apache.maven.api.Project;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.services.BuilderProblem;
import org.apache.maven.api.services.DependencyResolverResult;
import org.apache.maven.api.services.ProjectBuilder;
import org.apache.maven.api.services.ProjectBuilderException;
import org.apache.maven.api.services.ProjectBuilderRequest;
import org.apache.maven.api.services.ProjectBuilderResult;
import org.apache.maven.api.services.Source;
import org.apache.maven.api.services.Sources;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.impl.DefaultDependencyResolverResult;
import org.apache.maven.impl.InternalSession;
import org.apache.maven.impl.MappedCollection;
import org.apache.maven.impl.RequestTraceHelper;
import org.apache.maven.model.building.ModelProblem;
import org.apache.maven.model.building.ModelSource2;
import org.apache.maven.project.DefaultProjectBuildingRequest;
import org.apache.maven.project.ProjectBuildingException;
import org.apache.maven.project.ProjectBuildingRequest;
import org.apache.maven.project.ProjectBuildingResult;
@Named
@Singleton
public class DefaultProjectBuilder implements ProjectBuilder {
private final org.apache.maven.project.ProjectBuilder builder;
@Inject
public DefaultProjectBuilder(org.apache.maven.project.ProjectBuilder builder) {
this.builder = builder;
}
@SuppressWarnings("MethodLength")
@Nonnull
@Override
public ProjectBuilderResult build(ProjectBuilderRequest request)
throws ProjectBuilderException, IllegalArgumentException {
InternalSession session = InternalSession.from(request.getSession());
return session.request(request, this::doBuild);
}
protected ProjectBuilderResult doBuild(ProjectBuilderRequest request)
throws ProjectBuilderException, IllegalArgumentException {
InternalMavenSession session = InternalMavenSession.from(request.getSession());
RequestTraceHelper.ResolverTrace trace = RequestTraceHelper.enter(request.getSession(), request);
try {
List<ArtifactRepository> repositories = session.toArtifactRepositories(
request.getRepositories() != null ? request.getRepositories() : session.getRemoteRepositories());
ProjectBuildingRequest req = new DefaultProjectBuildingRequest()
.setRepositorySession(session.getSession())
.setRemoteRepositories(repositories)
.setPluginArtifactRepositories(repositories)
.setProcessPlugins(request.isProcessPlugins());
ProjectBuildingResult res;
if (request.getPath().isPresent()) {
Path path = request.getPath().get();
res = builder.build(path.toFile(), req);
} else if (request.getSource().isPresent()) {
Source source = request.getSource().get();
ModelSource2 modelSource = new SourceWrapper(source);
res = builder.build(modelSource, req);
} else {
throw new IllegalArgumentException("Invalid request");
}
return new ProjectBuilderResult() {
@Override
public ProjectBuilderRequest getRequest() {
return request;
}
@Nonnull
@Override
public String getProjectId() {
return res.getProjectId();
}
@Nonnull
@Override
public Optional<Path> getPomFile() {
return Optional.ofNullable(res.getPomFile()).map(File::toPath);
}
@Nonnull
@Override
public Optional<Project> getProject() {
return Optional.ofNullable(session.getProject(res.getProject()));
}
@Nonnull
@Override
public Collection<BuilderProblem> getProblems() {
return new MappedCollection<>(res.getProblems(), this::toProblem);
}
private BuilderProblem toProblem(ModelProblem problem) {
return new BuilderProblem() {
@Override
public String getSource() {
return problem.getSource();
}
@Override
public int getLineNumber() {
return problem.getLineNumber();
}
@Override
public int getColumnNumber() {
return problem.getColumnNumber();
}
@Override
public String getLocation() {
StringBuilder buffer = new StringBuilder(256);
if (!getSource().isEmpty()) {
buffer.append(getSource());
}
if (getLineNumber() > 0) {
if (!buffer.isEmpty()) {
buffer.append(", ");
}
buffer.append("line ").append(getLineNumber());
}
if (getColumnNumber() > 0) {
if (!buffer.isEmpty()) {
buffer.append(", ");
}
buffer.append("column ").append(getColumnNumber());
}
return buffer.toString();
}
@Override
public Exception getException() {
return problem.getException();
}
@Override
public String getMessage() {
return problem.getMessage();
}
@Override
public Severity getSeverity() {
return Severity.valueOf(problem.getSeverity().name());
}
};
}
@Nonnull
@Override
public Optional<DependencyResolverResult> getDependencyResolverResult() {
return Optional.ofNullable(res.getDependencyResolutionResult())
.map(r -> new DefaultDependencyResolverResult(
null, r.getCollectionErrors(), session.getNode(r.getDependencyGraph()), 0));
}
};
} catch (ProjectBuildingException e) {
throw new ProjectBuilderException("Unable to build project", e);
} finally {
RequestTraceHelper.exit(trace);
}
}
static class SourceWrapper implements ModelSource2 {
private final Source source;
SourceWrapper(Source source) {
this.source = source;
}
@Override
public InputStream getInputStream() throws IOException {
return source.openStream();
}
@Override
public String getLocation() {
return source.getLocation();
}
/**
* Returns the POM which the relative path designates, for instance the parent POM of the one of this source.
* The path is resolved against the directory which contains the file of this source, like a
* {@code FileModelSource} does, and not against the file itself, which {@link Source#resolve(String)} would do.
*
* @param relPath the path of the related POM, or of its directory, relative to the directory of this source
* @return the related source, or {@code null} if this source is not backed by a file, or if there is no
* readable POM at that path
*/
@Override
public ModelSource2 getRelatedSource(String relPath) {
Path path = source.getPath();
if (path == null || path.getParent() == null) {
// there is no directory to resolve a relative path against
return null;
}
// the relative path of a parent may use either kind of slash, whatever the platform is
Path related;
try {
related = path.getParent()
.resolve(relPath.replace('\\', File.separatorChar).replace('/', File.separatorChar));
} catch (InvalidPathException e) {
return null;
}
if (Files.isDirectory(related)) {
// TODO use ModelSource.ModelLocator.locateExistingPom(Path) instead of hardcoding "pom.xml"
// so that polyglot ModelParser extensions are honoured.
// Same limitation exists in FileModelSource.getRelatedSource(String).
related = related.resolve("pom.xml");
}
if (Files.isRegularFile(related) && Files.isReadable(related)) {
return new SourceWrapper(Sources.fromPath(related));
}
return null;
}
@Override
public URI getLocationURI() {
Path path = source.getPath();
return path != null ? path.toUri() : URI.create(source.getLocation());
}
}
}