Adding compat aspect to maven-core to give one-stop-shopping for backward compatibility measures and reduce pollution in main codebase.

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@589908 13f79535-47bb-0310-9956-ffa450edef68

build.xml

@@ -268,6 +268,7 @@ under the License.
       <classpath refid="maven.classpath"/>
       <arg value="-e"/>
       <arg value="-B"/>
+      <arg value="-P compat,standard"/>
       <arg value="clean"/>
       <arg value="install"/>
     </java>

maven-core/pom.xml

@@ -141,4 +141,36 @@ under the License.
       </plugin>
     </plugins>
   </build>
+  
+  <profiles>
+    <profile>
+      <id>compat</id>
+      
+      <dependencies>
+        <dependency>
+          <groupId>aspectj</groupId>
+          <artifactId>aspectjrt</artifactId>
+          <version>1.5.3</version>
+        </dependency>
+      </dependencies>
+      
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>aspectj-maven-plugin</artifactId>
+            
+            <executions>
+              <execution>
+                <id>weave-compat</id>
+                <goals>
+                  <goal>compile</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
 </project>

maven-core/src/main/aspect/org/apache/maven/compat/plugin/Maven20xCompatAspect.aj

@@ -0,0 +1,199 @@
+package org.apache.maven.compat.plugin;
+
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.apache.maven.execution.MavenExecutionResult;
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.extension.DefaultExtensionManager;
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.factory.ArtifactFactory;
+import org.apache.maven.artifact.metadata.ResolutionGroup;
+import org.apache.maven.artifact.repository.ArtifactRepository;
+import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
+import org.apache.maven.artifact.resolver.ArtifactResolutionException;
+import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
+import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
+import org.apache.maven.artifact.versioning.VersionRange;
+import org.apache.maven.model.Plugin;
+import org.apache.maven.plugin.DefaultPluginManager;
+import org.apache.maven.plugin.InvalidPluginException;
+import org.apache.maven.plugin.PluginManager;
+import org.apache.maven.plugin.PluginManagerException;
+import org.apache.maven.plugin.PluginNotFoundException;
+import org.apache.maven.plugin.descriptor.PluginDescriptor;
+import org.apache.maven.plugin.version.PluginVersionNotFoundException;
+import org.apache.maven.plugin.version.PluginVersionResolutionException;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.settings.MavenSettingsBuilder;
+import org.apache.maven.settings.Settings;
+import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
+
+import java.io.IOException;
+import java.util.Iterator;
+import java.util.LinkedHashSet;
+import java.util.Set;
+
+public privileged aspect Maven20xCompatAspect
+{
+
+    // GRAB Session and Request.
+    private MavenSession session;
+    private MavenExecutionRequest request;
+
+    private pointcut sessionCreation( MavenSession session ): execution( public MavenSession.new(..) ) && this( session );
+
+    after( MavenSession session ): sessionCreation( session )
+    {
+        this.session = session;
+    }
+
+    private pointcut methodsTakingRequest( MavenExecutionRequest request ):
+        execution( MavenExecutionResult *.*( MavenExecutionRequest ) )
+        && args( request );
+
+    before( MavenExecutionRequest request ): methodsTakingRequest( request )
+    {
+        this.request = request;
+    }
+
+    // USE Session to compensate for old verifyPlugin(..) API.
+    private pointcut verifyPlugin( Plugin plugin, MavenProject project, PluginManager manager ):
+        call( public PluginDescriptor PluginManager+.verifyPlugin( Plugin, MavenProject, Settings, ArtifactRepository ) )
+        && args( plugin, project, .. )
+        && target( manager );
+
+    PluginDescriptor around( Plugin plugin,
+                             MavenProject project,
+                             PluginManager manager )
+        throws ArtifactResolutionException, ArtifactNotFoundException, PluginNotFoundException,
+        PluginVersionResolutionException, InvalidPluginException, PluginManagerException,
+        PluginVersionNotFoundException:
+            verifyPlugin( plugin, project, manager )
+    {
+        return manager.verifyPlugin( plugin, project, session );
+    }
+
+    // Re-Introduce old verifyPlugin(..) API.
+    public PluginDescriptor PluginManager.verifyPlugin( Plugin plugin,
+                                                        MavenProject project,
+                                                        Settings settings,
+                                                        ArtifactRepository localRepository )
+    {
+        // this will always be diverted, so no need to do anything.
+        return null;
+    }
+
+    // Intercept retrieval of artifact dependencies of an extension, inject plexus-utils if it's not there.
+    private pointcut extDepArtifactsResolved( DefaultExtensionManager mgr ):
+        call( public Set ResolutionGroup.getArtifacts() )
+        && within( DefaultExtensionManager )
+        && this( mgr );
+
+    Set around( DefaultExtensionManager mgr ): extDepArtifactsResolved( mgr )
+    {
+        Set result = proceed( mgr );
+
+        checkPlexusUtils( result, mgr.artifactFactory );
+
+        return result;
+    }
+
+    // Intercept retrieval of artifact dependencies of a plugin, inject plexus-utils if it's not there.
+    private pointcut pluginDepArtifactsResolved( DefaultPluginManager mgr ):
+        call( public Set ResolutionGroup.getArtifacts() )
+        && cflow( execution( Set DefaultPluginManager.getPluginArtifacts(..) ) )
+        && this( mgr );
+
+    Set around( DefaultPluginManager mgr ): pluginDepArtifactsResolved( mgr )
+    {
+        Set result = proceed( mgr );
+
+        checkPlexusUtils( result, mgr.artifactFactory );
+
+        return result;
+    }
+
+    // USE Request to compensate for old buildSettings() API.
+    private pointcut buildSettings( MavenSettingsBuilder builder ):
+        execution( public Settings MavenSettingsBuilder+.buildSettings() )
+        && target( builder );
+
+    Settings around( MavenSettingsBuilder builder )
+        throws IOException, XmlPullParserException:
+            buildSettings( builder )
+    {
+        return builder.buildSettings( request );
+    }
+
+    // Re-Introduce old buildSettings() API.
+    public Settings MavenSettingsBuilder.buildSettings()
+        throws IOException, XmlPullParserException
+    {
+        return null;
+    }
+
+    // --------------------------
+    // UTILITIES
+    // --------------------------
+
+    private VersionRange vr = null;
+    private Artifact plexusUtilsArtifact = null;
+
+    private void checkPlexusUtils( Set dependencyArtifacts, ArtifactFactory artifactFactory )
+    {
+        // ----------------------------------------------------------------------------
+        // If the plugin already declares a dependency on plexus-utils then we're all
+        // set as the plugin author is aware of its use. If we don't have a dependency
+        // on plexus-utils then we must protect users from stupid plugin authors who
+        // did not declare a direct dependency on plexus-utils because the version
+        // Maven uses is hidden from downstream use. We will also bump up any
+        // anything below 1.1 to 1.1 as this mimics the behaviour in 2.0.5 where
+        // plexus-utils 1.1 was being forced into use.
+        // ----------------------------------------------------------------------------
+
+        if ( vr == null )
+        {
+            try
+            {
+                vr = VersionRange.createFromVersionSpec( "[1.1,)" );
+            }
+            catch ( InvalidVersionSpecificationException e )
+            {
+                // Won't happen
+            }
+        }
+
+        boolean plexusUtilsPresent = false;
+
+        for ( Iterator i = dependencyArtifacts.iterator(); i.hasNext(); )
+        {
+            Artifact a = (Artifact) i.next();
+
+            if ( a.getArtifactId().equals( "plexus-utils" )
+                 && vr.containsVersion( new DefaultArtifactVersion( a.getVersion() ) ) )
+            {
+                plexusUtilsPresent = true;
+
+                break;
+            }
+        }
+
+        if ( !plexusUtilsPresent )
+        {
+            // We will add plexus-utils as every plugin was getting this anyway from Maven itself. We will set the
+            // version to the latest version we know that works as of the 2.0.6 release. We set the scope to runtime
+            // as this is what's implicitly happening in 2.0.6.
+
+            if ( plexusUtilsArtifact == null )
+            {
+                plexusUtilsArtifact = artifactFactory.createArtifact( "org.codehaus.plexus",
+                                                                      "plexus-utils",
+                                                                      "1.1",
+                                                                      Artifact.SCOPE_RUNTIME,
+                                                                      "jar" );
+            }
+
+            dependencyArtifacts.add( plexusUtilsArtifact );
+        }
+    }
+
+}

maven-core/src/main/java/org/apache/maven/extension/DefaultExtensionManager.java

@@ -39,7 +39,6 @@ import org.apache.maven.execution.MavenProjectSession;
 import org.apache.maven.model.Extension;
 import org.apache.maven.model.Model;
 import org.apache.maven.model.Parent;
-import org.apache.maven.plugin.DefaultPluginManager;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.MutablePlexusContainer;
 import org.codehaus.plexus.PlexusConstants;
@@ -225,7 +224,7 @@ public class DefaultExtensionManager
 
             // We use the same hack here to make sure that plexus 1.1 is available for extensions that do
             // not declare plexus-utils but need it. MNG-2900
-            DefaultPluginManager.checkPlexusUtils( resolutionGroup, artifactFactory );
+//            DefaultPluginManager.checkPlexusUtils( resolutionGroup, artifactFactory );
 
             Set dependencies = new LinkedHashSet();
 

maven-core/src/main/java/org/apache/maven/plugin/DefaultPluginManager.java

@@ -552,7 +552,7 @@ public class DefaultPluginManager
                                                    pluginArtifact, e );
         }
 
-        checkPlexusUtils( resolutionGroup, artifactFactory );
+//        checkPlexusUtils( resolutionGroup, artifactFactory );
 
         Set dependencies = new LinkedHashSet();
 

maven-embedder/pom.xml

@@ -76,6 +76,18 @@ under the License.
     </site>
   </distributionManagement>
   <profiles>
+    <profile>
+      <id>compat</id>
+      
+      <dependencies>
+        <dependency>
+          <groupId>aspectj</groupId>
+          <artifactId>aspectjrt</artifactId>
+          <version>1.5.3</version>
+        </dependency>
+      </dependencies>
+    </profile>
+    
     <profile>
       <!--
        |