/*
* Copyright 2011 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.api.internal.artifacts.ivyservice.ivyresolve.parser;
import com.google.common.collect.Maps;
import org.gradle.api.artifacts.ModuleVersionIdentifier;
import org.gradle.api.artifacts.ModuleVersionSelector;
import org.gradle.api.artifacts.component.ModuleComponentIdentifier;
import org.gradle.api.internal.artifacts.DefaultModuleVersionSelector;
import org.gradle.api.internal.artifacts.ImmutableModuleIdentifierFactory;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.parser.PomReader.PomDependencyData;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.parser.data.MavenDependencyKey;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.parser.data.PomDependencyMgt;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.MavenVersionSelectorScheme;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorScheme;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.excludes.ModuleExclusions;
import org.gradle.api.internal.component.ArtifactType;
import org.gradle.internal.component.external.descriptor.ModuleDescriptorState;
import org.gradle.internal.component.external.model.DefaultModuleComponentIdentifier;
import org.gradle.internal.component.external.model.DefaultMutableMavenModuleResolveMetadata;
import org.gradle.internal.component.external.model.MutableMavenModuleResolveMetadata;
import org.gradle.internal.component.model.DependencyMetadata;
import org.gradle.internal.resource.local.LocallyAvailableExternalResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;
import java.io.IOException;
import java.text.ParseException;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* This based on a copy of org.apache.ivy.plugins.parser.m2.PomModuleDescriptorParser, but now heavily refactored.
*/
public final class GradlePomModuleDescriptorParser extends AbstractModuleDescriptorParser<MutableMavenModuleResolveMetadata> {
private static final Logger LOGGER = LoggerFactory.getLogger(GradlePomModuleDescriptorParser.class);
private static final String DEPENDENCY_IMPORT_SCOPE = "import";
private final VersionSelectorScheme gradleVersionSelectorScheme;
private final VersionSelectorScheme mavenVersionSelectorScheme;
private final ImmutableModuleIdentifierFactory moduleIdentifierFactory;
private final ModuleExclusions moduleExclusions;
public GradlePomModuleDescriptorParser(VersionSelectorScheme gradleVersionSelectorScheme, ImmutableModuleIdentifierFactory moduleIdentifierFactory, ModuleExclusions moduleExclusions) {
this.gradleVersionSelectorScheme = gradleVersionSelectorScheme;
mavenVersionSelectorScheme = new MavenVersionSelectorScheme(gradleVersionSelectorScheme);
this.moduleIdentifierFactory = moduleIdentifierFactory;
this.moduleExclusions = moduleExclusions;
}
@Override
protected String getTypeName() {
return "POM";
}
public String toString() {
return "gradle pom parser";
}
protected MutableMavenModuleResolveMetadata doParseDescriptor(DescriptorParseContext parserSettings, LocallyAvailableExternalResource resource, boolean validate) throws IOException, ParseException, SAXException {
PomReader pomReader = new PomReader(resource, moduleIdentifierFactory);
GradlePomModuleDescriptorBuilder mdBuilder = new GradlePomModuleDescriptorBuilder(pomReader, gradleVersionSelectorScheme, mavenVersionSelectorScheme, moduleIdentifierFactory, moduleExclusions);
doParsePom(parserSettings, mdBuilder, pomReader);
ModuleDescriptorState moduleDescriptor = mdBuilder.getModuleDescriptor();
List<DependencyMetadata> dependencies = mdBuilder.getDependencies();
ModuleComponentIdentifier cid = moduleDescriptor.getComponentIdentifier();
ModuleVersionIdentifier id = moduleIdentifierFactory.moduleWithVersion(cid.getGroup(), cid.getModule(), cid.getVersion());
if (pomReader.getRelocation() != null) {
return new DefaultMutableMavenModuleResolveMetadata(id, moduleDescriptor, "pom", true, dependencies);
}
return new DefaultMutableMavenModuleResolveMetadata(id, moduleDescriptor, pomReader.getPackaging(), false, dependencies);
}
private void doParsePom(DescriptorParseContext parserSettings, GradlePomModuleDescriptorBuilder mdBuilder, PomReader pomReader) throws IOException, SAXException {
if (pomReader.hasParent()) {
//Is there any other parent properties?
ModuleComponentIdentifier parentId = DefaultModuleComponentIdentifier.newId(
pomReader.getParentGroupId(),
pomReader.getParentArtifactId(),
pomReader.getParentVersion());
PomReader parentPomReader = parseParentPom(parserSettings, parentId, pomReader.getAllPomProperties());
pomReader.setPomParent(parentPomReader);
}
pomReader.resolveGAV();
String groupId = pomReader.getGroupId();
String artifactId = pomReader.getArtifactId();
String version = pomReader.getVersion();
mdBuilder.setModuleRevId(groupId, artifactId, version);
mdBuilder.setDescription(pomReader.getDescription());
ModuleVersionIdentifier relocation = pomReader.getRelocation();
if (relocation != null) {
if (groupId != null && artifactId != null && artifactId.equals(relocation.getName()) && groupId.equals(relocation.getGroup())) {
LOGGER.error("POM relocation to an other version number is not fully supported in Gradle : {} relocated to {}.",
mdBuilder.getModuleDescriptor().getComponentIdentifier(), relocation);
LOGGER.warn("Please update your dependency to directly use the correct version '{}'.", relocation);
LOGGER.warn("Resolution will only pick dependencies of the relocated element. Artifacts and other metadata will be ignored.");
PomReader relocatedModule = parseOtherPom(parserSettings, DefaultModuleComponentIdentifier.newId(relocation));
Collection<PomDependencyData> pomDependencyDataList = relocatedModule.getDependencies().values();
for(PomDependencyData pomDependencyData : pomDependencyDataList) {
mdBuilder.addDependency(pomDependencyData);
}
} else {
LOGGER.info(mdBuilder.getModuleDescriptor().getComponentIdentifier()
+ " is relocated to " + relocation
+ ". Please update your dependencies.");
LOGGER.debug("Relocated module will be considered as a dependency");
ModuleVersionSelector selector = DefaultModuleVersionSelector.newSelector(relocation.getGroup(), relocation.getName(), relocation.getVersion());
mdBuilder.addDependencyForRelocation(selector);
}
} else {
overrideDependencyMgtsWithImported(parserSettings, pomReader);
for (PomDependencyData dependency : pomReader.getDependencies().values()) {
mdBuilder.addDependency(dependency);
}
}
}
/**
* Overrides existing dependency management information with imported ones if existing.
*
* @param parseContext Parse context
* @param pomReader POM reader
* @throws IOException
* @throws SAXException
*/
private void overrideDependencyMgtsWithImported(DescriptorParseContext parseContext, PomReader pomReader) throws IOException, SAXException {
Map<MavenDependencyKey, PomDependencyMgt> importedDependencyMgts = parseImportedDependencyMgts(parseContext, pomReader.parseDependencyMgt());
pomReader.addImportedDependencyMgts(importedDependencyMgts);
}
/**
* Parses imported dependency management information.
*
* @param parseContext Parse context
* @param currentDependencyMgts Current dependency management information
* @return Imported dependency management information
* @throws IOException
* @throws SAXException
*/
private Map<MavenDependencyKey, PomDependencyMgt> parseImportedDependencyMgts(DescriptorParseContext parseContext, Collection<PomDependencyMgt> currentDependencyMgts) throws IOException, SAXException {
Map<MavenDependencyKey, PomDependencyMgt> importedDependencyMgts = new LinkedHashMap<MavenDependencyKey, PomDependencyMgt>();
for(PomDependencyMgt currentDependencyMgt : currentDependencyMgts) {
if(isDependencyImportScoped(currentDependencyMgt)) {
PomReader importDescr = parseImportedPom(parseContext, currentDependencyMgt);
importedDependencyMgts.putAll(importDescr.getDependencyMgt());
}
}
return importedDependencyMgts;
}
/**
* Checks if dependency has scope "import".
*
* @param dependencyMgt Dependency management element
* @return Flag
*/
private boolean isDependencyImportScoped(PomDependencyMgt dependencyMgt) {
return DEPENDENCY_IMPORT_SCOPE.equals(dependencyMgt.getScope());
}
private PomReader parseImportedPom(DescriptorParseContext parseContext, PomDependencyMgt pomDependencyMgt) throws IOException, SAXException {
ModuleComponentIdentifier importedId = DefaultModuleComponentIdentifier.newId(pomDependencyMgt.getGroupId(), pomDependencyMgt.getArtifactId(), pomDependencyMgt.getVersion());
return parsePom(parseContext, importedId, Maps.<String, String>newHashMap());
}
private PomReader parseOtherPom(DescriptorParseContext parseContext, ModuleComponentIdentifier parentId) throws IOException, SAXException {
return parsePom(parseContext, parentId, Maps.<String, String>newHashMap());
}
private PomReader parseParentPom(DescriptorParseContext parseContext, ModuleComponentIdentifier parentId, Map<String, String> childProperties) throws IOException, SAXException {
return parsePom(parseContext, parentId, childProperties);
}
private PomReader parsePom(DescriptorParseContext parseContext, ModuleComponentIdentifier parentId, Map<String, String> childProperties) throws IOException, SAXException {
LocallyAvailableExternalResource localResource = parseContext.getMetaDataArtifact(parentId, ArtifactType.MAVEN_POM);
PomReader pomReader = new PomReader(localResource, moduleIdentifierFactory, childProperties);
GradlePomModuleDescriptorBuilder mdBuilder = new GradlePomModuleDescriptorBuilder(pomReader, gradleVersionSelectorScheme, mavenVersionSelectorScheme, moduleIdentifierFactory, moduleExclusions);
doParsePom(parseContext, mdBuilder, pomReader);
return pomReader;
}
}