15 Commits
6 changed files with 138 additions and 13 deletions
+3
View File
@@ -7,3 +7,6 @@ pom.xml.versionsBackup
.project
.classpath
# Visual Studio Code
.factorypath
+2 -3
View File
@@ -8,7 +8,7 @@
<groupId>com.inteligr8.alfresco</groupId>
<artifactId>amp-plugin</artifactId>
<version>1.0.4</version>
<version>1.0.6</version>
<packaging>maven-plugin</packaging>
<name>A Maven plugin to generate AMP files</name>
@@ -117,9 +117,8 @@
<repository>
<id>inteligr8-releases</id>
<name>Inteligr8 Releases</name>
<url>http://repos.inteligr8.com/nexus/repository/inteligr8-public</url>
<url>https://repos.inteligr8.com/nexus/repository/inteligr8-public</url>
</repository>
</distributionManagement>
</project>
@@ -6,7 +6,10 @@ import java.io.FileInputStream;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.zip.ZipEntry;
@@ -23,15 +26,32 @@ import org.eclipse.aether.resolution.ArtifactResult;
public class AmpDependencyFilter implements DependencyFilter {
private final Pattern modulePropertiesPattern = Pattern.compile("^alfresco/module/[^/]+/module\\.properties$");
private final String moduleExtension = "amp";
private final Set<String> ignoreDependenciesOfParentScopes = new HashSet<>(Arrays.asList("provided", "system"));
private final int streamBufferSize = 16 * 1024;
private final Log log;
private final Charset charset;
private final ArtifactResolutionCallback callback;
private final String projectModuleId;
private Set<String> moduleIds = new HashSet<String>();
private Set<String> notModuleIds = new HashSet<String>();
public AmpDependencyFilter(Log log, String charsetName, ArtifactResolutionCallback callback) {
this.log = log;
this.charset = Charset.forName(charsetName);
this.callback = callback;
this.projectModuleId = this.getModuleId(this.callback.getProject().getArtifact());
}
private String getModuleId(org.apache.maven.artifact.Artifact artifact) {
return artifact.getGroupId() + "." + artifact.getArtifactId();
}
private String getModuleId(Artifact artifact) {
return artifact.getGroupId() + "." + artifact.getArtifactId();
}
@Override
@@ -39,12 +59,74 @@ public class AmpDependencyFilter implements DependencyFilter {
Artifact artifact = node.getArtifact();
if (this.log.isDebugEnabled())
this.log.debug("Checking dependency: " + artifact.getArtifactId());
String possibleModuleId = this.getModuleId(artifact);
if (this.projectModuleId.equals(possibleModuleId)) {
// always include project itself, even if it is a module
return true;
}
try {
if (this.isOrIsInAlfrescoModule(possibleModuleId, node, parents.iterator())) {
if (this.log.isDebugEnabled())
this.log.debug("Not packaging library; detected as Alfresco Module or as dependency to other Alfresco Module: " + artifact.getArtifactId());
return false;
}
} catch (NotInScopeException nise) {
if (this.log.isDebugEnabled())
this.log.debug("Not packaging library; detected as provided by another dependency [" + nise.getNotInScopeParentArtifact() + "]: " + artifact.getArtifactId());
return false;
}
return true;
}
private boolean isOrIsInAlfrescoModule(String possibleModuleId, DependencyNode depNode, Iterator<DependencyNode> parents) throws NotInScopeException {
Artifact artifact = depNode.getArtifact();
if (this.projectModuleId.equals(possibleModuleId)) {
return false;
} else if (depNode.getDependency() != null && this.ignoreDependenciesOfParentScopes.contains(depNode.getDependency().getScope())) {
throw new NotInScopeException(artifact);
} else if (this.moduleIds.contains(possibleModuleId)) {
if (this.log.isDebugEnabled())
this.log.debug("Detected as Alfresco Module: " + artifact.getArtifactId());
return true;
} else if (this.notModuleIds.contains(possibleModuleId)) {
return false;
} else if (parents != null && parents.hasNext()) {
DependencyNode parentNode = parents.next();
String parentModuleId = this.getModuleId(parentNode.getArtifact());
if (this.log.isDebugEnabled())
this.log.debug("Checking parent dependency: " + artifact.getArtifactId());
if (this.isOrIsInAlfrescoModule(parentModuleId, parentNode, parents)) {
if (this.log.isDebugEnabled())
this.log.debug("Detected as dependency to other Alfresco Module: " + artifact.getArtifactId());
return true;
}
}
// never seen this artifact or its parents
return this.isAlfrescoModule(possibleModuleId, depNode);
}
private boolean isAlfrescoModule(String possibleModuleId, DependencyNode depNode) {
Artifact artifact = depNode.getArtifact();
if (this.moduleExtension.equalsIgnoreCase(artifact.getExtension())) {
if (this.log.isDebugEnabled())
this.log.debug("Detected as Alfresco Module: " + artifact.getArtifactId());
this.moduleIds.add(possibleModuleId);
return true;
}
File file = artifact.getFile();
try {
if (file == null) {
if (this.log.isDebugEnabled())
this.log.debug("Resolving dependency: " + artifact.getArtifactId());
ArtifactResult result = this.callback.resolveArtifact(new ArtifactRequest(node));
this.log.debug("Resolving dependency to get file: " + artifact.getArtifactId());
ArtifactResult result = this.callback.resolveArtifact(new ArtifactRequest(depNode));
if (result.isMissing() || !result.isResolved())
throw new ArtifactResolutionException(Arrays.asList(result));
artifact = result.getArtifact();
@@ -53,23 +135,25 @@ public class AmpDependencyFilter implements DependencyFilter {
if (this.log.isDebugEnabled())
this.log.debug("Checking dependency file: " + file);
if (this.isAlfrescoModule(file)) {
if (this.isAlfrescoModuleJar(file)) {
this.moduleIds.add(possibleModuleId);
if (this.log.isInfoEnabled())
this.log.info("Not packaging JAR; detected as Alfresco JAR Module: " + node.getArtifact().getArtifactId());
return false;
this.log.info("Detected as Alfresco Module: " + artifact.getArtifactId());
return true;
}
return true;
this.notModuleIds.add(possibleModuleId);
return false;
} catch (ArtifactResolutionException are) {
this.log.warn("An artifact could not be resolved; assuming it is not an Alfresco module and continuing");
return true;
return false;
} catch (IOException ie) {
this.log.warn("An I/O issue occurred while inspecting a JAR to see if it is an Alfresco module; assuming it isn't and continuing");
return true;
return false;
}
}
}
private boolean isAlfrescoModule(File file) throws IOException {
public boolean isAlfrescoModuleJar(File file) throws IOException {
FileInputStream fistream = new FileInputStream(file);
BufferedInputStream bistream = new BufferedInputStream(fistream, this.streamBufferSize);
ZipInputStream zstream = new ZipInputStream(bistream, this.charset);
@@ -90,6 +90,11 @@ public class AmpMojo extends AbstractMojo implements ArtifactResolutionCallback
@Parameter( property = "skip", required = true, defaultValue = "false" )
protected boolean skip;
@Override
public MavenProject getProject() {
return this.project;
}
public void execute() throws MojoExecutionException {
if (this.skip) {
@@ -1,11 +1,14 @@
package com.inteligr8.alfresco.amp;
import org.apache.maven.project.MavenProject;
import org.eclipse.aether.resolution.ArtifactRequest;
import org.eclipse.aether.resolution.ArtifactResolutionException;
import org.eclipse.aether.resolution.ArtifactResult;
public interface ArtifactResolutionCallback {
MavenProject getProject();
ArtifactResult resolveArtifact(ArtifactRequest artifactRequest) throws ArtifactResolutionException;
}
@@ -0,0 +1,31 @@
package com.inteligr8.alfresco.amp;
import org.eclipse.aether.artifact.Artifact;
public class NotInScopeException extends Exception {
private static final long serialVersionUID = 8055701654626788700L;
private final Artifact notInScopeParentArtifact;
private Artifact impactedChildArtifact;
public NotInScopeException(Artifact notInScopeParentArtifact) {
super("The '" + notInScopeParentArtifact.getArtifactId() + "' artifact is not scope");
this.notInScopeParentArtifact = notInScopeParentArtifact;
}
public NotInScopeException(Artifact notInScopeParentArtifact, Artifact impactedChildArtifact) {
super("The '" + notInScopeParentArtifact.getArtifactId() + "' artifact is not scope, impacting the '" + impactedChildArtifact.getArtifactId() + "' artifact");
this.notInScopeParentArtifact = notInScopeParentArtifact;
this.impactedChildArtifact = impactedChildArtifact;
}
public Artifact getNotInScopeParentArtifact() {
return this.notInScopeParentArtifact;
}
public Artifact getImpactedChildArtifact() {
return this.impactedChildArtifact;
}
}