Merge pull request #35 from FlintMC/feature/instrumentation

Feature/instrumentation

Author: R0bbyYT

build.gradle.kts

@@ -87,6 +87,10 @@ dependencies {
     implementation(group = "net.flintmc.installer", name = "logic-implementation", version = "2.0.2")
     implementation(group = "net.flintmc.installer", name = "logic", version = "2.0.2")
 
+    implementation(group = "org.ow2.asm", name = "asm", version = "9.1")
+    implementation(group = "org.ow2.asm",name = "asm-tree", version = "9.1")
+    implementation(group = "org.ow2.asm", name ="asm-commons", version = "9.1")
+
     implementation(group = "com.cloudbees", name = "diff4j", version = "1.2")
 }
 

src/main/java/net/flintmc/gradle/FlintGradlePlugin.java

@@ -26,6 +26,7 @@
 import net.flintmc.gradle.java.JarTaskProvider;
 import net.flintmc.gradle.java.JavaPluginInteraction;
 import net.flintmc.gradle.java.RunConfigurationProvider;
+import net.flintmc.gradle.java.instrumentation.Instrumentation;
 import net.flintmc.gradle.manifest.ManifestConfigurator;
 import net.flintmc.gradle.manifest.dev.DevelopmentStaticFiles;
 import net.flintmc.gradle.maven.FlintResolutionStrategy;
@@ -77,6 +78,8 @@ public class FlintGradlePlugin implements Plugin<Project> {
 
   private FlintGradlePlugin parentPlugin;
 
+  private Instrumentation instrumentation;
+
   @Override
   public void apply(@Nonnull Project project) {
     this.project = project;
@@ -132,6 +135,9 @@ public void apply(@Nonnull Project project) {
         throw new UncheckedIOException("Failed to create Yggdrasil authenticator", e);
       }
 
+      this.instrumentation = new Instrumentation();
+      this.instrumentation.apply(project);
+
       this.runConfigurationProvider = new RunConfigurationProvider(
           project, minecraftRepository, minecraftCache.resolve("run"), authenticator, httpClient);
       this.jarTaskProvider = new JarTaskProvider();
@@ -153,6 +159,8 @@ public void apply(@Nonnull Project project) {
       this.runConfigurationProvider = parentPlugin.runConfigurationProvider;
       this.jarTaskProvider = parentPlugin.jarTaskProvider;
       this.mavenArtifactURLCache = parentPlugin.mavenArtifactURLCache;
+      this.instrumentation = parentPlugin.instrumentation;
+      this.instrumentation.apply(project);
     }
 
     this.manifestConfigurator = new ManifestConfigurator(this);
@@ -328,4 +336,12 @@ public Project getProject() {
   public MavenArtifactDownloader getDownloader() {
     return this.downloader;
   }
+
+  public FlintGradleExtension getExtension() {
+    return extension;
+  }
+
+  public MinecraftRepository getMinecraftRepository() {
+    return this.minecraftRepository;
+  }
 }

src/main/java/net/flintmc/gradle/environment/DefaultDeobfuscationEnvironment.java

@@ -19,21 +19,20 @@
 
 package net.flintmc.gradle.environment;
 
+import java.io.File;
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Enumeration;
-import java.util.HashSet;
-import java.util.Set;
+import java.util.*;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
 import java.util.jar.JarInputStream;
 import java.util.jar.JarOutputStream;
+
+import com.google.common.collect.ImmutableMap;
 import net.flintmc.gradle.maven.pom.MavenArtifact;
 import net.flintmc.gradle.minecraft.data.environment.DefaultInput;
 import net.flintmc.gradle.minecraft.data.environment.EnvironmentType;

src/main/java/net/flintmc/gradle/environment/DeobfuscationEnvironment.java

@@ -19,13 +19,18 @@
 
 package net.flintmc.gradle.environment;
 
+import java.io.File;
 import java.util.Collection;
+import java.util.Map;
+
 import net.flintmc.gradle.environment.mcp.ModCoderPackEnvironment;
 import net.flintmc.gradle.environment.yarn.YarnEnvironment;
 import net.flintmc.gradle.maven.pom.MavenArtifact;
 import net.flintmc.gradle.maven.pom.MavenPom;
+import net.flintmc.gradle.minecraft.data.environment.DefaultInput;
 import net.flintmc.gradle.minecraft.data.environment.EnvironmentInput;
 import net.flintmc.gradle.minecraft.data.environment.EnvironmentType;
+import okhttp3.OkHttpClient;
 
 /** Represents a deobfuscation environment which can be used to obtain the minecraft source. */
 public interface DeobfuscationEnvironment {
@@ -43,6 +48,8 @@ static DeobfuscationEnvironment createFor(EnvironmentInput input, EnvironmentTyp
    */
   String name();
 
+  Map<String, File> getDownloadedMappingFiles(OkHttpClient httpClient, EnvironmentCacheFileProvider environmentCacheFileProvider) throws DeobfuscationException;
+
   /**
    * Runs the deobfuscation on the given client and server artifacts. One of the 2 artifacts may be null, but never both
    * at the same time.

src/main/java/net/flintmc/gradle/environment/mcp/ModCoderPackEnvironment.java

@@ -19,19 +19,8 @@
 
 package net.flintmc.gradle.environment.mcp;
 
-import java.io.IOException;
-import java.io.UncheckedIOException;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import net.flintmc.gradle.environment.DefaultDeobfuscationEnvironment;
-import net.flintmc.gradle.environment.DeobfuscationException;
-import net.flintmc.gradle.environment.DeobfuscationUtilities;
-import net.flintmc.gradle.environment.EnvironmentCacheFileProvider;
-import net.flintmc.gradle.environment.SourceJarProcessor;
+import com.google.common.collect.ImmutableMap;
+import net.flintmc.gradle.environment.*;
 import net.flintmc.gradle.java.exec.JavaExecutionResult;
 import net.flintmc.gradle.maven.SimpleMavenRepository;
 import net.flintmc.gradle.maven.pom.MavenArtifact;
@@ -45,7 +34,19 @@
 import org.gradle.api.logging.Logger;
 import org.gradle.api.logging.Logging;
 
-/** Implementation of the MCP as a deobfuscation environment. */
+import java.io.File;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Implementation of the MCP as a deobfuscation environment.
+ */
 public class ModCoderPackEnvironment extends DefaultDeobfuscationEnvironment {
   private static final Logger LOGGER = Logging.getLogger(ModCoderPackEnvironment.class);
 
@@ -61,7 +62,31 @@ public ModCoderPackEnvironment(DefaultInput input) {
     this.input = input;
   }
 
-  /** {@inheritDoc} */
+  @Override
+  public Map<String, File> getDownloadedMappingFiles(OkHttpClient httpClient, EnvironmentCacheFileProvider cacheFileProvider) throws DeobfuscationException {
+
+    return ImmutableMap.of(
+        "mcp-config",
+        this.downloadAndExtractZip(
+            LOGGER,
+            cacheFileProvider,
+            httpClient,
+            input.getConfigDownload().toExternalForm(),
+            "mcp-config_" + input.getConfigVersion()).toFile(),
+        "mcp-mappings",
+        this.downloadAndExtractZip(
+                LOGGER,
+                cacheFileProvider,
+                httpClient,
+                input.getMappingsDownload().toExternalForm(),
+                "mcp-mappings_" + input.getMappingsVersion())
+            .toFile()
+    );
+  }
+
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public void runDeobfuscation(
       MavenPom clientPom, MavenPom serverPom, DeobfuscationUtilities utilities)

src/main/java/net/flintmc/gradle/environment/yarn/YarnEnvironment.java

@@ -19,6 +19,7 @@
 
 package net.flintmc.gradle.environment.yarn;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -57,6 +58,11 @@ public YarnEnvironment(DefaultInput input) {
     this.input = input;
   }
 
+  @Override
+  public Map<String, File> getDownloadedMappingFiles(OkHttpClient httpClient, EnvironmentCacheFileProvider environmentCacheFileProvider) throws DeobfuscationException {
+    return null;
+  }
+
   /** {@inheritDoc} */
   @Override
   public void runDeobfuscation(

src/main/java/net/flintmc/gradle/java/instrumentation/Instrumentation.java

@@ -0,0 +1,81 @@
+/*
+ * FlintMC
+ * Copyright (C) 2020-2021 LabyMedia GmbH and contributors
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+package net.flintmc.gradle.java.instrumentation;
+
+import net.flintmc.gradle.java.instrumentation.tasks.InstrumentationTask;
+import net.flintmc.gradle.util.Util;
+import org.gradle.api.Project;
+import org.gradle.api.Task;
+import org.gradle.api.artifacts.Configuration;
+import org.gradle.api.file.ConfigurableFileCollection;
+import org.gradle.api.plugins.JavaBasePlugin;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.SourceSetContainer;
+
+public class Instrumentation {
+
+  private static final String GROUP = "flint-instrumentation";
+
+  /**
+   * Applies post compile instrumentation capabilities to a given project.
+   *
+   * @param project the project to apply the instrumentation to
+   */
+  public void apply(final Project project) {
+    // Whether the project has applied the java base plugin
+    if (!project.getPlugins().hasPlugin(JavaBasePlugin.class)) {
+      return;
+    }
+
+    Configuration instrumentation = project.getConfigurations().maybeCreate("instrumentation");
+    instrumentation.setCanBeResolved(true);
+
+    SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);
+    sourceSets.all(sourceSet -> this.configure(project, sourceSet, instrumentation));
+  }
+
+  /**
+   * Configures the instrumentation tasks.
+   *
+   * @param project   The project in which the instrumentation tasks are to be configured.
+   * @param sourceSet The {@link SourceSet} in which the instrumentation tasks are to be
+   *                  configured.
+   */
+  private void configure(final Project project, final SourceSet sourceSet, Configuration instrumentationConfiguration) {
+    InstrumentationTask instrumentationTask = project.getTasks()
+        .create(sourceSet.getTaskName("instrument", "code") + Util.capitalize(project.getName()),
+            InstrumentationTask.class);
+    instrumentationTask.getOutputs().dir(sourceSet.getOutput().getClassesDirs().getSingleFile().getPath() + "-instrumented");
+    instrumentationTask.dependsOn(sourceSet.getClassesTaskName());
+    instrumentationTask.setGroup(GROUP);
+    instrumentationTask.setSourceSet(sourceSet);
+    instrumentationTask.setConfiguration(instrumentationConfiguration);
+
+    Task postInstrumentationTask = project.getTasks()
+        .create("post" + Util.capitalize(instrumentationTask.getName()));
+    postInstrumentationTask.dependsOn(instrumentationTask);
+    postInstrumentationTask.setGroup(GROUP);
+    postInstrumentationTask.doLast(task -> {
+      ((ConfigurableFileCollection) sourceSet.getOutput().getClassesDirs()).setFrom(instrumentationTask.getOutputs().getFiles().getSingleFile());
+    });
+    sourceSet.compiledBy(postInstrumentationTask);
+  }
+
+}

src/main/java/net/flintmc/gradle/java/instrumentation/api/InstrumentationException.java

@@ -0,0 +1,36 @@
+/*
+ * FlintMC
+ * Copyright (C) 2020-2021 LabyMedia GmbH and contributors
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+package net.flintmc.gradle.java.instrumentation.api;
+
+import net.flintmc.gradle.FlintGradleException;
+
+public class InstrumentationException extends FlintGradleException {
+
+  public InstrumentationException() {
+  }
+
+  public InstrumentationException(String message) {
+    super(message);
+  }
+
+  public InstrumentationException(String message, Throwable cause) {
+    super(message, cause);
+  }
+}

src/main/java/net/flintmc/gradle/java/instrumentation/api/InstrumentationTransformerRegistrator.java

@@ -0,0 +1,40 @@
+/*
+ * FlintMC
+ * Copyright (C) 2020-2021 LabyMedia GmbH and contributors
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+package net.flintmc.gradle.java.instrumentation.api;
+
+/**
+ * Entry point of an instrumentation.
+ * Requires a Java Service to be registered and findable via a {@link java.util.ServiceLoader}.
+ * This class exists only to make it possible to use things like dependency injection in a {@link net.flintmc.gradle.java.instrumentation.api.transformer.InstrumentationTransformer}.
+ * If the {@link java.util.ServiceLoader} would look for {@link net.flintmc.gradle.java.instrumentation.api.transformer.InstrumentationTransformer} this would not be possible to do.
+ * Furthermore, it is possible to specify more details about the {@link net.flintmc.gradle.java.instrumentation.api.transformer.InstrumentationTransformer} to register.
+ *
+ * @see InstrumentationTransformerRegistry
+ */
+public interface InstrumentationTransformerRegistrator {
+
+  /**
+   * Initialize the instrumentation chain.
+   *
+   * @param registry the transformer registry to register all transformers on and retrieve information about the current transformation
+   */
+  void initialize(InstrumentationTransformerRegistry registry);
+
+}