au.net.causal.maven.plugins.userextensions.UserExtensionsJvmAgent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of user-extensions-maven-extension Show documentation
Show all versions of user-extensions-maven-extension Show documentation
Adds user-scoped extensions.xml support to Maven
The newest version!
package au.net.causal.maven.plugins.userextensions;
import javassist.CannotCompileException;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.LoaderClassPath;
import javassist.NotFoundException;
import javassist.expr.ExprEditor;
import javassist.expr.MethodCall;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.lang.instrument.Instrumentation;
import java.net.JarURLConnection;
import java.net.URISyntaxException;
import java.net.URL;
import java.security.ProtectionDomain;
import java.util.EnumSet;
import java.util.Locale;
import java.util.Set;
import java.util.jar.JarFile;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
public class UserExtensionsJvmAgent
{
private final Set features;
public static void premain(String agentArgs, Instrumentation inst)
{
Set features = Feature.parseArgs(agentArgs);
UserExtensionsJvmAgent agent = new UserExtensionsJvmAgent(features);
agent.run(inst);
}
public UserExtensionsJvmAgent(Set features)
{
this.features = EnumSet.copyOf(features);
}
public void run(Instrumentation inst)
{
inst.addTransformer(new ClassFileTransformer()
{
@Override
public byte[] transform(ClassLoader loader, String className, Class classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer)
throws IllegalClassFormatException
{
try
{
if ("org/apache/maven/cli/MavenCli".equals(className))
{
ClassPool classPool = new ClassPool(null);
classPool.appendClassPath(new LoaderClassPath(loader));
CtClass ctClass = classPool.makeClass(new ByteArrayInputStream(classfileBuffer));
CtMethod loadCoreExtensionsMethod = ctClass.getDeclaredMethod("loadCoreExtensions");
transformLoadCoreExtensionsMethod(loadCoreExtensionsMethod);
classfileBuffer = ctClass.toBytecode();
ctClass.detach();
}
else if ("org/apache/maven/cli/internal/BootstrapCoreExtensionManager".equals(className) && features.contains(Feature.ENHANCED_INTERPOLATION))
{
ClassPool classPool = new ClassPool(null);
classPool.appendClassPath(new LoaderClassPath(loader));
CtClass ctClass = classPool.makeClass(new ByteArrayInputStream(classfileBuffer));
CtMethod resolveCoreExtensionsMethod = ctClass.getDeclaredMethod("resolveCoreExtensions");
transformResolveCoreExtensionsMethod(resolveCoreExtensionsMethod);
CtMethod createInterpolatorMethod = ctClass.getDeclaredMethod("createInterpolator");
transformCreateInterpolatorMethod(createInterpolatorMethod);
classfileBuffer = ctClass.toBytecode();
ctClass.detach();
}
else if ("org/jetbrains/idea/maven/server/MavenServerCMDState".equals(className) && features.contains(Feature.IDEA))
{
ClassPool classPool = new ClassPool(null);
classPool.appendClassPath(new LoaderClassPath(loader));
CtClass ctClass = classPool.makeClass(new ByteArrayInputStream(classfileBuffer));
CtMethod createJavaParametersMethod = ctClass.getDeclaredMethod("createJavaParameters");
transformCreateJavaParametersMethod(createJavaParametersMethod);
classfileBuffer = ctClass.toBytecode();
ctClass.detach();
}
}
catch (Throwable e)
{
e.printStackTrace();
}
return classfileBuffer;
}
});
}
private void transformLoadCoreExtensionsMethod(CtMethod m)
throws CannotCompileException
{
m.instrument(new ExprEditor()
{
@Override
public void edit(MethodCall c) throws CannotCompileException
{
//Want to always get to readCoreExtensionsDescriptor() code in MavenCli.loadCoreExtensions()
//so we ensure this code:
// File extensionsFile = new File( cliRequest.multiModuleProjectDirectory, EXTENSIONS_FILENAME );
// if ( !extensionsFile.isFile() )
// {
// return Collections.emptyList();
// }
//always returns true by changing the isFile() call to omit the check if we are dealing with a file named ".../.mvn/extensions.xml"
if (File.class.getName().equals(c.getClassName()) && "isFile".equals(c.getMethodName()))
{
c.replace("if (\"extensions.xml\".equals($0.getName()) && \".mvn\".equals($0.getParentFile().getName())) { " +
" $_ = true; " +
"} else { $_ = $proceed($$); }");
}
//readCoreExtensionsDescriptor() call needs to be updated
// - if project-specific extensions.xml file exists, call readCoreExtensionsDescriptor() and save results to list
// - if user-global extensions.xml in .m2 directory exists, cal readCoreExtensionsDescriptor() with this file and save results to list
else if ("org.apache.maven.cli.MavenCli".equals(c.getClassName()) && "readCoreExtensionsDescriptor".equals(c.getMethodName()))
{
//Determine name of userMavenConfigurationHome public static variable
//it changes name from Maven 3.3.9 to 3.5.0
String userMavenConfigurationHomeFieldName;
try
{
userMavenConfigurationHomeFieldName = m.getDeclaringClass().getField("USER_MAVEN_CONFIGURATION_HOME").getName();
}
catch (NotFoundException e)
{
//Maven 3.3.9 and earlier
userMavenConfigurationHomeFieldName = "userMavenConfigurationHome";
}
c.replace(
//Initialize list
"$_ = new java.util.ArrayList(); " +
//Read project extensions.xml file first, if file exists
"if ($1.isFile()) { $_.addAll($proceed($$)); } " +
//Now try a user-global extensions.xml file, if it exists
"String userExtensionsFileName = System.getProperty(\"maven.user.extensions\");" +
"java.io.File userExtensionsFile;" +
"if (userExtensionsFileName != null) { " +
" userExtensionsFile = new java.io.File(userExtensionsFileName);" +
"} else { " +
" userExtensionsFile = new java.io.File(" + userMavenConfigurationHomeFieldName + ", \"extensions.xml\");" +
"} " +
"if (userExtensionsFile.isFile()) { $_.addAll($proceed(userExtensionsFile)); } " +
//Deduplicate extensions that might have same groupId/artifactId but different versions. First one in the list wins.
//This is so that extensions added at project level can override the versions of user-global extensions with different versions if needed.
//Project-level always wins against user-level.
"if (!$_.isEmpty()) { " +
" java.util.Set gaIds = new java.util.HashSet(); " +
" for (java.util.Iterator i = $_.iterator(); i.hasNext();) { " +
" org.apache.maven.cli.internal.extension.model.CoreExtension ext = (org.apache.maven.cli.internal.extension.model.CoreExtension)i.next();" +
" boolean added = gaIds.add(ext.getGroupId() + \":\" + ext.getArtifactId());" +
" if (!added) { i.remove(); } " +
" } " +
"} "
);
}
}
});
}
private void transformResolveCoreExtensionsMethod(CtMethod m)
throws CannotCompileException
{
m.instrument(new ExprEditor()
{
@Override
public void edit(MethodCall c) throws CannotCompileException
{
//If the version of the plugin after interpolation is determined to be 'disabled' then disregard that extension
if ("org.apache.maven.cli.internal.BootstrapCoreExtensionManager".equals(c.getClassName()) && "resolveExtension".equals(c.getMethodName()))
{
c.replace(
"if (\"disabled\".equalsIgnoreCase($5.interpolate($1.getVersion()))) { $_ = java.util.Collections.emptyList(); }" +
"else { $_ = $proceed($$); }"
);
}
}
});
}
private void transformCreateInterpolatorMethod(CtMethod m)
throws CannotCompileException
{
m.insertAfter(
"org.apache.maven.model.building.DefaultModelBuilder builder = new org.apache.maven.model.building.DefaultModelBuilderFactory().newInstance();" +
//Don't care that this model building fails (using a directory as POM file) but we want to grab the active profiles from the exception at the end
//and that gets resolved whether the POM file is real or not
"org.apache.maven.model.building.DefaultModelBuildingRequest request = new org.apache.maven.model.building.DefaultModelBuildingRequest().setPomFile(new java.io.File(\".\"));" +
"request.setProfiles($1.getProfiles());" +
"request.setActiveProfileIds($1.getActiveProfiles());" +
"request.setInactiveProfileIds($1.getInactiveProfiles());" +
"request.setSystemProperties($1.getSystemProperties());" +
"request.setUserProperties($1.getUserProperties());" +
"request.setRawModel(new org.apache.maven.model.Model());" +
"org.apache.maven.model.building.ModelBuildingResult result = null;" +
"try {" +
" result = builder.build(request);" +
"} catch (org.apache.maven.model.building.ModelBuildingException ex) {" +
" result = ex.getResult();" +
"} " +
"java.util.List activeProfiles = result.getActiveExternalProfiles();" +
//Now we have resolved active profiles, add value sources in reverse order
//This is the way Maven works as well normally for properties in multiple profiles (later profiles should win), tested with Antrun
"for (java.util.ListIterator i = activeProfiles.listIterator(activeProfiles.size()); i.hasPrevious();) { " +
" org.apache.maven.model.Profile p = i.previous();" +
" java.util.Properties p2 = org.apache.maven.model.Profile.class.getMethod(\"getProperties\", null).invoke(p, null);" +
" $_.addValueSource(new org.codehaus.plexus.interpolation.MapBasedValueSource(p2));" +
"}"
);
}
/**
* Patch some IntelliJ Maven code that runs its Maven server so that it always adds our agent when running. This makes it easier to use for users
* since they don't have to edit every project and put the parameter for this agent in.
*/
private void transformCreateJavaParametersMethod(CtMethod m)
throws CannotCompileException
{
//Determine the JAR we are running from
String agentJarFile = getAgentJarFilePath();
if (agentJarFile == null)
{
System.err.println("Warning: could not determine path of agent JAR file.");
return;
}
//TODO better escaping for weird file names needed?
String agentJarFileEscaped = agentJarFile.replace("\\", "\\\\").replace("\"", "\\\"");
Set passThroughFeatures = EnumSet.copyOf(features);
passThroughFeatures.remove(Feature.IDEA);
String featureString = passThroughFeatures.stream().map(Feature::name).collect(Collectors.joining(","));
if (!featureString.isEmpty())
featureString = "=" + featureString;
m.insertAfter(
"$_.getVMParametersList().add(\"-javaagent:" + agentJarFileEscaped + featureString + "\");"
);
}
private String getAgentJarFilePath()
{
URL res = UserExtensionsJvmAgent.class.getResource(UserExtensionsJvmAgent.class.getSimpleName() + ".class");
if (res == null)
return null;
if (!res.toString().startsWith("jar:file:"))
return null;
try
{
//Intellij clobbers JAR URL handler - we can't rely on it being there
//Manually make a JarURLConnection just so we can use the code that grabs the parent JAR file of the resource
JarURLConnection con = new JarURLConnection(res)
{
@Override
public JarFile getJarFile() throws IOException
{
throw new Error("not used");
}
@Override
public void connect() throws IOException
{
throw new Error("not used");
}
};
return new File(con.getJarFileURL().toURI()).getAbsolutePath();
}
catch (IOException | URISyntaxException e)
{
e.printStackTrace();
}
return null;
}
public static enum Feature
{
ENHANCED_INTERPOLATION,
IDEA;
public static Set parseArgs(String args)
{
EnumSet features = EnumSet.noneOf(Feature.class);
if (args != null)
{
for (String arg : args.split(Pattern.quote("\\s+,\\s+")))
{
try
{
features.add(Feature.valueOf(arg.toUpperCase(Locale.ROOT)));
}
catch (IllegalArgumentException e)
{
System.err.println("Warning: unknown user-extensions agent feature: " + arg);
}
}
}
return features;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy