v1.3.6 pom

pom.xml

@@ -7,7 +7,7 @@
 
 	<groupId>com.inteligr8</groupId>
 	<artifactId>ban-maven-plugin</artifactId>
-	<version>1.2.2</version>
+	<version>1.3.6</version>
 	<packaging>maven-plugin</packaging>
 
 	<name>Ban Dependencies Maven Plugin</name>
@@ -106,6 +106,9 @@
 						<goals>
 							<goal>descriptor</goal>
 						</goals>
+						<configuration>
+							<goalPrefix>ban</goalPrefix>
+						</configuration>
 					</execution>
 					<execution>
 						<id>help-descriptor</id>

src/main/java/com/inteligr8/maven/ban/AbstractBanConfiguration.java

@@ -30,9 +30,14 @@ import org.codehaus.plexus.util.xml.Xpp3Dom;
 import org.eclipse.aether.artifact.Artifact;
 import org.eclipse.aether.artifact.DefaultArtifact;
 import org.eclipse.aether.impl.ArtifactResolver;
+import org.eclipse.aether.impl.VersionRangeResolver;
 import org.eclipse.aether.resolution.ArtifactRequest;
 import org.eclipse.aether.resolution.ArtifactResolutionException;
 import org.eclipse.aether.resolution.ArtifactResult;
+import org.eclipse.aether.resolution.VersionRangeRequest;
+import org.eclipse.aether.resolution.VersionRangeResolutionException;
+import org.eclipse.aether.resolution.VersionRangeResult;
+import org.eclipse.aether.version.Version;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -48,11 +53,13 @@ public abstract class AbstractBanConfiguration implements BanConfiguration {
     protected final List<ArtifactFilter> excludeArtifacts = new LinkedList<>();
 
     private final ArtifactResolver artifactResolver;
+    private final VersionRangeResolver versionRangeResolver;
     private final MavenSession session;
     
-    public AbstractBanConfiguration(MavenSession session, ArtifactResolver artifactResolver) {
+    public AbstractBanConfiguration(MavenSession session, ArtifactResolver artifactResolver, VersionRangeResolver versionRangeResolver) {
         this.session = session;
         this.artifactResolver = artifactResolver;
+        this.versionRangeResolver = versionRangeResolver;
     }
     
     public void init(Xpp3Dom rootDom) throws IOException, MojoFailureException {
@@ -69,18 +76,33 @@ public abstract class AbstractBanConfiguration implements BanConfiguration {
         for (Xpp3Dom child : importDom.getChildren()) {
             BanConfigurationDownloader downloader = null;
             if (child.getName().equals("url")) {
-                String url = StringUtils.trimToNull(importDom.getValue());
-                downloader = new BanConfigurationDownloader(this.session, this.artifactResolver, url);
+                String url = StringUtils.trimToNull(child.getValue());
+                downloader = new BanConfigurationDownloader(this.session, this.artifactResolver, this.versionRangeResolver, url);
             } else if (child.getName().equals("artifact")) {
                 Artifact artifact = new DefaultArtifact(child.getValue());
-                ArtifactRequest request = new ArtifactRequest(artifact, this.session.getCurrentProject().getRemoteProjectRepositories(), null);
+                if (!"xml".equals(artifact.getExtension()))
+                    artifact = new DefaultArtifact(artifact.getGroupId(), artifact.getArtifactId(), artifact.getClassifier(), "xml", artifact.getVersion());
                 
+                VersionRangeRequest vrrequest = new VersionRangeRequest(artifact, this.session.getCurrentProject().getRemoteProjectRepositories(), null);
                 try {
-                    ArtifactResult result = this.artifactResolver.resolveArtifact(this.session.getRepositorySession(), request);
-                    File file = result.getArtifact().getFile();
-                    downloader = new BanConfigurationDownloader(this.session,  this.artifactResolver, file);
-                } catch (ArtifactResolutionException are) {
-                    this.logger.warn("The artifact could not be resolved; skipping: {}", child.getValue());
+                    VersionRangeResult vrresult = this.versionRangeResolver.resolveVersionRange(this.session.getRepositorySession(), vrrequest);
+                    if (vrresult.getVersions().isEmpty()) {
+                        this.logger.error("The artifact version range could not be resolved; skipping: {}", child.getValue());
+                    } else {
+                        Version version = vrresult.getHighestVersion();
+                        artifact = artifact.setVersion(version.toString());
+                        
+                        ArtifactRequest arequest = new ArtifactRequest(artifact, this.session.getCurrentProject().getRemoteProjectRepositories(), null);
+                        try {
+                            ArtifactResult aresult = this.artifactResolver.resolveArtifact(this.session.getRepositorySession(), arequest);
+                            File file = aresult.getArtifact().getFile();
+                            downloader = new BanConfigurationDownloader(this.session, this.artifactResolver, this.versionRangeResolver, file);
+                        } catch (ArtifactResolutionException are) {
+                            this.logger.warn("The artifact version could not be resolved; skipping: {}", artifact, version);
+                        }
+                    }
+                } catch (VersionRangeResolutionException vrre) {
+                    this.logger.error("The artifact version range could not be resolved; skipping: {}", child.getValue());
                 }
             }
             

src/main/java/com/inteligr8/maven/ban/BanConfigurationDownloader.java

@@ -27,6 +27,7 @@ import org.codehaus.plexus.util.xml.Xpp3Dom;
 import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 import org.eclipse.aether.impl.ArtifactResolver;
+import org.eclipse.aether.impl.VersionRangeResolver;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -34,8 +35,8 @@ public class BanConfigurationDownloader extends AbstractBanConfiguration {
     
     private final Logger logger = LoggerFactory.getLogger(this.getClass());
     
-    public BanConfigurationDownloader(MavenSession session, ArtifactResolver artifactResolver, String url) throws IOException, MojoFailureException {
-        super(session, artifactResolver);
+    public BanConfigurationDownloader(MavenSession session, ArtifactResolver artifactResolver, VersionRangeResolver versionRangeResolver, String url) throws IOException, MojoFailureException {
+        super(session, artifactResolver, versionRangeResolver);
         
         try {
             Xpp3Dom rootDom = this.load(new URL(url));
@@ -45,8 +46,8 @@ public class BanConfigurationDownloader extends AbstractBanConfiguration {
         }
     }
     
-    public BanConfigurationDownloader(MavenSession session, ArtifactResolver artifactResolver, File file) throws IOException, MojoFailureException {
-        super(session, artifactResolver);
+    public BanConfigurationDownloader(MavenSession session, ArtifactResolver artifactResolver, VersionRangeResolver versionRangeResolver, File file) throws IOException, MojoFailureException {
+        super(session, artifactResolver, versionRangeResolver);
         
         try {
             Xpp3Dom rootDom = this.load(file);

src/main/java/com/inteligr8/maven/ban/BanConfigurationParser.java

@@ -21,11 +21,12 @@ import org.apache.maven.model.Plugin;
 import org.apache.maven.plugin.MojoFailureException;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 import org.eclipse.aether.impl.ArtifactResolver;
+import org.eclipse.aether.impl.VersionRangeResolver;
 
 public class BanConfigurationParser extends AbstractBanConfiguration {
     
-    public BanConfigurationParser(MavenSession session, ArtifactResolver artifactResolver, Plugin plugin) throws IOException, MojoFailureException {
-        super(session, artifactResolver);
+    public BanConfigurationParser(MavenSession session, ArtifactResolver artifactResolver, VersionRangeResolver versionRangeResolver, Plugin plugin) throws IOException, MojoFailureException {
+        super(session, artifactResolver, versionRangeResolver);
         
         Xpp3Dom rootDom = (Xpp3Dom) plugin.getConfiguration();
         this.init(rootDom);

src/main/java/com/inteligr8/maven/ban/BanExtension.java

@@ -29,6 +29,7 @@ import org.apache.maven.model.Plugin;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugin.PluginResolutionException;
 import org.apache.maven.plugin.internal.PluginDependenciesResolver;
+import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.DefaultDependencyResolutionRequest;
 import org.apache.maven.project.DependencyResolutionException;
 import org.apache.maven.project.DependencyResolutionResult;
@@ -40,9 +41,12 @@ import org.eclipse.aether.graph.Dependency;
 import org.eclipse.aether.graph.DependencyFilter;
 import org.eclipse.aether.graph.DependencyNode;
 import org.eclipse.aether.impl.ArtifactResolver;
+import org.eclipse.aether.impl.VersionRangeResolver;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.inteligr8.maven.ban.model.ImportConfig;
+
 @Named("ban")
 @Singleton
 public class BanExtension extends AbstractMavenLifecycleParticipant {
@@ -56,12 +60,27 @@ public class BanExtension extends AbstractMavenLifecycleParticipant {
     @Inject
     private ArtifactResolver artifactResolver;
     
+    @Inject
+    private VersionRangeResolver versionRangeResolver;
+    
     @Inject
     private ProjectDependenciesResolver projDepResolver;
     
     @Inject
     private PluginDependenciesResolver pluginDepResolver;
 
+    /**
+     * The configuration is parsed manually.  This is here to prevent warning messages with IDEs and builders.
+     */
+    @Parameter(name = "import")
+    private ImportConfig importConfig;
+
+    @Parameter(name = "includes")
+    private List<String> includes;
+
+    @Parameter(name = "excludes")
+    private List<String> excludes;
+    
     @Override
     public void afterProjectsRead(MavenSession session) throws MavenExecutionException {
         BanConfiguration config = this.getConfiguration(session);
@@ -113,7 +132,7 @@ public class BanExtension extends AbstractMavenLifecycleParticipant {
             return null;
         } else {
             try {
-                return new BanConfigurationParser(session, this.artifactResolver, plugin);
+                return new BanConfigurationParser(session, this.artifactResolver, this.versionRangeResolver, plugin);
             } catch (IOException | MojoFailureException e) {
                 throw new MavenExecutionException(e.getMessage(), project.getFile());
             }

src/main/java/com/inteligr8/maven/ban/PurgeRepoMojo.java

@@ -16,6 +16,7 @@ package com.inteligr8.maven.ban;
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.DirectoryNotEmptyException;
 import java.nio.file.FileVisitResult;
 import java.nio.file.FileVisitor;
 import java.nio.file.Files;
@@ -23,6 +24,7 @@ import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.Iterator;
 import java.util.LinkedList;
 import java.util.List;
@@ -45,6 +47,7 @@ import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.component.annotations.Component;
 import org.eclipse.aether.impl.ArtifactResolver;
+import org.eclipse.aether.impl.VersionRangeResolver;
 
 import com.inteligr8.maven.model.ArtifactFilter;
 
@@ -58,6 +61,9 @@ public class PurgeRepoMojo extends AbstractMojo {
     @Inject
     private ArtifactResolver artifactResolver;
     
+    @Inject
+    private VersionRangeResolver versionRangeResolver;
+    
     @Parameter(name = "skip", defaultValue = "false")
     private boolean skip = false;
     
@@ -90,10 +96,13 @@ public class PurgeRepoMojo extends AbstractMojo {
                 continue;
             }
             
-            Path groupPath = this.getGroupPath(afilter);
-            List<Path> artifactPaths = this.getArtifactPaths(groupPath, afilter);
+            Path groupPath = this.resolveGroupPath(afilter);
+            if (groupPath == null)
+                continue;
+            
+            List<Path> artifactPaths = this.resolveArtifactPaths(groupPath, afilter);
             for (Path artifactPath : artifactPaths)
-                includePaths.addAll(this.getVersionPaths(artifactPath, afilter.getVersionRange()));
+                includePaths.addAll(this.resolveVersionPaths(artifactPath, afilter.getVersionRange()));
         }
 
         this.getLog().debug("May be purging all files in " + includePaths.size() + " paths");
@@ -105,7 +114,7 @@ public class PurgeRepoMojo extends AbstractMojo {
             StringBuilder regex = new StringBuilder();
             
             if (afilter.getGroupId() != null) {
-                regex.append('^').append(this.getGroupPath(afilter));
+                regex.append('^').append(this.resolveGroupPath(afilter));
             } else if (afilter.getGroupIdRegex() != null) {
                 regex.append(afilter.getGroupIdRegex().replace("\\.", regexDirectorySeparator));
                 if (regex.charAt(0) != '^')
@@ -150,14 +159,14 @@ public class PurgeRepoMojo extends AbstractMojo {
             this.getLog().info("DRYRUN: Would have deleted certain paths from local Maven cache: " + repoPath);
             this.getLog().info("DRYRUN: Would have deleted these paths: " + includePaths);
         } else {
-            for (Path path : includePaths) {
-                Path fullpath = repoPath.resolve(path);
-                if (Files.exists(fullpath)) {
-                    this.getLog().info("Deleting version from Maven cache: " + path);
-                    Files.walkFileTree(fullpath, new DeleteDirectoryVisitor());
+            for (Path versionPath : includePaths) {
+                Path fullVersionPath = repoPath.resolve(versionPath);
+                if (Files.exists(fullVersionPath)) {
+                    this.getLog().info("Deleting version from Maven cache: " + versionPath);
+                    Files.walkFileTree(fullVersionPath, new DeleteNonMetadataVisitor());
                 } else {
                     // this will probably never happen
-                    this.getLog().debug("Maven cache does not exist: " + path);
+                    this.getLog().debug("Maven cache does not exist: " + versionPath);
                 }
             }
         }
@@ -168,23 +177,42 @@ public class PurgeRepoMojo extends AbstractMojo {
         Plugin plugin = project.getPlugin(BanExtension.THIS_PLUGIN_KEY);
         if (plugin == null)
             throw new MojoFailureException("The plugin is executing but it cannot be found");
-        return new BanConfigurationParser(this.session, this.artifactResolver, plugin);
+        return new BanConfigurationParser(this.session, this.artifactResolver, this.versionRangeResolver, plugin);
     }
     
-    private Path getGroupPath(ArtifactFilter afilter) {
+    private Path resolveGroupPath(ArtifactFilter afilter) {
+        if (afilter.getGroupId() == null)
+            return null;
+        
         String[] pathElements = afilter.getGroupId().split("\\.");
         Path groupPath = Paths.get("");
         for (String pathElement : pathElements)
             groupPath = groupPath.resolve(pathElement);
+        
+        Path fullGroupPath = this.getRepositoryPath().resolve(groupPath);
+        if (!Files.exists(fullGroupPath)) {
+            this.getLog().debug("The group path does not exist, so nothing to purge: " + fullGroupPath);
+            return null;
+        }
+        
         return groupPath;
     }
     
-    private List<Path> getArtifactPaths(Path groupPath, ArtifactFilter afilter) throws IOException {
-        if (afilter.getArtifactId() != null)
-            return Arrays.asList(groupPath.resolve(afilter.getArtifactId()));
+    private List<Path> resolveArtifactPaths(Path groupPath, ArtifactFilter afilter) throws IOException {
+        Path repoPath = this.getRepositoryPath();
+        
+        if (afilter.getArtifactId() != null) {
+            Path artifactPath = groupPath.resolve(afilter.getArtifactId());
+            Path fullArtifactPath = repoPath.resolve(artifactPath);
+            if (Files.exists(fullArtifactPath)) {
+                return Arrays.asList(artifactPath);
+            } else {
+                this.getLog().debug("The artifact path does not exist, so nothing to purge: " + fullArtifactPath);
+                return Collections.emptyList();
+            }
+        }
         
         Pattern artifactPattern = afilter.getArtifactIdRegex() == null ? null : Pattern.compile(afilter.getArtifactIdRegex());
-        Path repoPath = this.getRepositoryPath();
         List<Path> paths = new LinkedList<>();
         
         if (artifactPattern == null)
@@ -192,14 +220,27 @@ public class PurgeRepoMojo extends AbstractMojo {
         
         Files.list(repoPath.resolve(groupPath)).forEach(new Consumer<Path>() {
             @Override
-            public void accept(Path t) {
+            public void accept(Path fullArtifactPath) {
                 if (artifactPattern == null) {
-                    paths.add(repoPath.relativize(t));
+                    // these may include sub-groups and not just artifacts
+                    // which will lead to paths with artifacts as versions
+                    // so we are looping through versions to see if it is indeed an artifact
+                    try {
+                        Files.list(fullArtifactPath).findFirst().ifPresent(new Consumer<Path>() {
+                            @Override
+                            public void accept(Path fullVersionPath) {
+                                if (Files.exists(fullVersionPath.resolve("_remote.repositories")))
+                                    paths.add(repoPath.relativize(fullArtifactPath));
+                            }
+                        });
+                    } catch (IOException ie) {
+                        getLog().error(ie.getMessage(), ie);
+                    }
                 } else {
-                    Matcher matcher = artifactPattern.matcher(t.getFileName().toString());
+                    Matcher matcher = artifactPattern.matcher(fullArtifactPath.getFileName().toString());
                     if (matcher.matches()) {
-                        getLog().debug("The artifact directory '" + t.getFileName() + "' qualifies as included");
-                        paths.add(repoPath.relativize(t));
+                        getLog().debug("The artifact directory '" + fullArtifactPath.getFileName() + "' qualifies as included");
+                        paths.add(repoPath.relativize(fullArtifactPath));
                     }
                 }
             }
@@ -208,7 +249,7 @@ public class PurgeRepoMojo extends AbstractMojo {
         return paths;
     }
     
-    private List<Path> getVersionPaths(Path artifactPath, VersionRange versionRange) throws IOException {
+    private List<Path> resolveVersionPaths(Path artifactPath, VersionRange versionRange) throws IOException {
         Path repoPath = this.getRepositoryPath();
         List<Path> paths = new LinkedList<>();
         
@@ -239,7 +280,9 @@ public class PurgeRepoMojo extends AbstractMojo {
     
     
     
-    private class DeleteDirectoryVisitor implements FileVisitor<Path> {
+    private class DeleteNonMetadataVisitor implements FileVisitor<Path> {
+        
+        private final Pattern versionPathPattern = Pattern.compile("/([^/]+)/([^/]+)/[^/]+$");
         
         @Override
         public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
@@ -248,12 +291,33 @@ public class PurgeRepoMojo extends AbstractMojo {
         
         @Override
         public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
-            try {
-                if (!attrs.isDirectory())
+            if (attrs.isDirectory()) {
+                getLog().warn("An unexpected directory was found: " + file);
+                return FileVisitResult.SKIP_SUBTREE;
+            }
+
+            Matcher matcher = this.versionPathPattern.matcher(file.toString());
+            if (!matcher.find()) {
+                getLog().debug("Ignoring file from purge: " + file);
+                return FileVisitResult.CONTINUE;
+            }
+            
+            String artifactId = matcher.group(1);
+            String version = matcher.group(2);
+            String includeName = artifactId + "-" + version;
+            String excludeName = artifactId + "-" + version + ".pom";
+            getLog().debug("artifact-version: " + includeName);
+            
+            if (file.getFileName().toString().startsWith(includeName) &&
+                    !file.getFileName().toString().startsWith(excludeName)) {
+                try {
+                    getLog().info("Deleting artifact: " + file);
                     Files.delete(file);
-            } catch (IOException ie) {
-                getLog().debug(ie);
-                getLog().warn("The file failed to delete: " + file);
+                } catch (IOException ie) {
+                    getLog().debug(ie);
+                    getLog().warn("The file failed to delete: " + file);
+                    return FileVisitResult.SKIP_SIBLINGS;
+                }
             }
             
             return FileVisitResult.CONTINUE;
@@ -268,6 +332,8 @@ public class PurgeRepoMojo extends AbstractMojo {
         public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
             try {
                 Files.delete(dir);
+            } catch (DirectoryNotEmptyException dnee) {
+                getLog().debug("The folder will not be deleted as it is not empty: " + dir);
             } catch (IOException ie) {
                 getLog().debug(ie);
                 getLog().warn("The folder failed to delete: " + dir);

src/main/java/com/inteligr8/maven/ban/model/Config.java

@@ -0,0 +1,11 @@
+package com.inteligr8.maven.ban.model;
+
+import java.util.List;
+
+public class Config {
+    
+    public ImportConfig importConfigs;
+    public List<String> includes;
+    public List<String> excludes;
+
+}

src/main/java/com/inteligr8/maven/ban/model/ImportConfig.java

@@ -0,0 +1,10 @@
+package com.inteligr8.maven.ban.model;
+
+import java.util.List;
+
+public class ImportConfig {
+    
+    public List<String> url;
+    public List<String> artifact;
+
+}