Merge pull request #17 from FlintMC/usability-patch

Usability patch (2.8.1)

Author: einrobin

build.gradle.kts

@@ -66,7 +66,7 @@ repositories {
     mavenCentral()
 }
 
-version = System.getenv().getOrDefault("VERSION", "2.8.0")
+version = System.getenv().getOrDefault("VERSION", "2.8.1")
 
 dependencies {
     implementation(group = "com.fasterxml.jackson.core", name = "jackson-core", version = "2.11.1")

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

@@ -44,18 +44,20 @@
 import net.flintmc.gradle.minecraft.data.environment.EnvironmentType;
 import net.flintmc.gradle.minecraft.data.environment.MinecraftVersion;
 import net.flintmc.gradle.minecraft.yggdrasil.YggdrasilAuthenticator;
+import net.flintmc.gradle.util.JavaClosure;
+import net.flintmc.gradle.util.Util;
 import okhttp3.OkHttpClient;
 import org.gradle.api.GradleException;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.invocation.Gradle;
+import org.gradle.api.tasks.Delete;
 
 public class FlintGradlePlugin implements Plugin<Project> {
   public static final String MINECRAFT_TASK_GROUP = "minecraft";
 
   private static final String MINECRAFT_MAVEN = "https://libraries.minecraft.net";
   private static final String MAVEN_CENTRAL = "https://repo.maven.apache.org/maven2/";
-  private static final String FLINT_MAVEN = "https://dist.labymod.net/api/v1/maven/release/";
 
   private Project project;
 
@@ -64,7 +66,6 @@ public class FlintGradlePlugin implements Plugin<Project> {
   private MavenArtifactURLCache mavenArtifactURLCache;
 
   private FlintGradleExtension extension;
-  private FlintPatcherExtension patcherExtension;
   private JavaPluginInteraction interaction;
   private MinecraftRepository minecraftRepository;
   private SimpleMavenRepository internalRepository;
@@ -105,7 +106,7 @@ public void apply(@Nonnull Project project) {
       }
 
       this.extension = project.getExtensions().create(FlintGradleExtension.NAME, FlintGradleExtension.class, this);
-      this.patcherExtension = project.getExtensions().create(FlintPatcherExtension.NAME, FlintPatcherExtension.class, this);
+      project.getExtensions().create(FlintPatcherExtension.NAME, FlintPatcherExtension.class, this);
 
       Path flintGradlePath = gradle.getGradleUserHomeDir().toPath().resolve("caches/flint-gradle");
       Path minecraftCache = flintGradlePath.resolve("minecraft-cache");
@@ -139,6 +140,7 @@ public void apply(@Nonnull Project project) {
       } catch (IOException e) {
         throw new UncheckedIOException("Failed to setup artifact URL cache", e);
       }
+
     } else {
       this.httpClient = parentPlugin.httpClient;
       this.downloader = parentPlugin.downloader;
@@ -154,9 +156,25 @@ public void apply(@Nonnull Project project) {
 
     this.manifestConfigurator = new ManifestConfigurator(this);
     interaction.setup();
-    project.afterEvaluate((p) -> {
-      extension.ensureConfigured();
-      FlintResolutionStrategy.getInstance().forceResolutionStrategy(p);
+    project.getTasks().getByName("clean").configure(
+        JavaClosure.of((Delete task) -> task.delete(Util.getProjectCacheDir(project))));
+
+    project.afterEvaluate((p) -> extension.ensureConfigured());
+
+    project.getRepositories().maven(repo -> {
+      repo.setName("Mojang");
+      repo.setUrl(MINECRAFT_MAVEN);
+    });
+
+    project.getRepositories().maven(repo -> {
+      repo.setName("Flint");
+      repo.setUrl(Util.getDistributorMavenURI(project));
+      Util.applyDistributorCredentials(project, repo, false);
+    });
+
+    project.getRepositories().maven((repo) -> {
+      repo.setName("Internal minecraft");
+      repo.setUrl(minecraftRepository.getBaseDir());
     });
   }
 
@@ -179,20 +197,7 @@ public void onExtensionConfigured() {
       }
     }
 
-    project.getRepositories().maven(repo -> {
-      repo.setName("Mojang");
-      repo.setUrl(MINECRAFT_MAVEN);
-    });
-
-    project.getRepositories().maven(repo -> {
-      repo.setName("Flint");
-      repo.setUrl(FLINT_MAVEN);
-    });
-
-    project.getRepositories().maven((repo) -> {
-      repo.setName("Internal minecraft");
-      repo.setUrl(minecraftRepository.getBaseDir());
-    });
+    FlintResolutionStrategy.getInstance().forceResolutionStrategy(project, extension);
 
     for (Project subProject : project.getSubprojects()) {
       if (!extension.getProjectFilter().test(subProject)) {
@@ -300,10 +305,6 @@ public MavenArtifactURLCache getMavenArtifactURLCache() {
     return mavenArtifactURLCache;
   }
 
-  public FlintPatcherExtension getPatcherExtension() {
-    return patcherExtension;
-  }
-
   public Project getProject() {
     return project;
   }

src/main/java/net/flintmc/gradle/manifest/ManifestConfigurator.java

@@ -27,7 +27,6 @@
 import net.flintmc.gradle.manifest.data.ManifestStaticFileInput;
 import net.flintmc.gradle.manifest.tasks.*;
 import net.flintmc.gradle.maven.cache.MavenArtifactURLCache;
-import net.flintmc.gradle.minecraft.InstallStaticFilesTask;
 import net.flintmc.gradle.property.FlintPluginProperties;
 import net.flintmc.gradle.util.MaybeNull;
 import net.flintmc.gradle.util.Util;
@@ -61,7 +60,6 @@ public ManifestConfigurator(FlintGradlePlugin plugin) {
   }
 
   private URI projectPublishURI;
-  private URI distributorMavenURI;
   private URI projectMavenURI;
 
   /**
@@ -79,7 +77,7 @@ public void configure() {
       PublishingExtension publishingExtension = project.getExtensions().findByType(PublishingExtension.class);
 
       // Build the distributor URL in form of <host>/maven/<channel>
-      URI distributorUrl = getDistributorMavenURI(
+      URI distributorUrl = Util.getDistributorMavenURI(project,
           "Set enablePublishing to false in the flint extension",
           "Set shouldAutoConfigurePublishing to false in the flint extension");
 
@@ -100,18 +98,8 @@ public void configure() {
             publishingExtension.getRepositories().maven((repo) -> repo.setName("FlintDistributor"));
         repository.setUrl(distributorUrl);
 
-        // Try to retrieve authentication, it might not be available
-        HttpHeaderCredentials values = Util.getPublishCredentials(project, false);
-
-        if(values != null) {
-          // Gradle does not allow setting the credentials instance directly, so copy it
-          HttpHeaderCredentials credentials = repository.getCredentials(HttpHeaderCredentials.class);
-          credentials.setName(values.getName());
-          credentials.setValue(values.getValue());
-        }
-
-        // Set the authentication, no further configuration required
-        repository.getAuthentication().create("header", HttpHeaderAuthentication.class);
+        // Apply the access credentials if available
+        Util.applyDistributorCredentials(project, repository, false);
       }
     }
 
@@ -240,26 +228,6 @@ public URI getProjectPublishURI(String... notAvailableSolutions) {
     return projectPublishURI;
   }
 
-  /**
-   * Retrieves the base URI of the distributor repository.
-   *
-   * @param notAvailableSolution Messages to display as a solution in case URI can't be computed
-   * @return The base URI of the distributor repository
-   */
-  public URI getDistributorMavenURI(String... notAvailableSolution) {
-    if(distributorMavenURI == null) {
-      distributorMavenURI = Util.concatURI(
-          FlintPluginProperties.DISTRIBUTOR_URL
-              .require(project, notAvailableSolution),
-          "api/v1/maven",
-          FlintPluginProperties.DISTRIBUTOR_CHANNEL
-              .require(project, notAvailableSolution)
-      );
-    }
-
-    return distributorMavenURI;
-  }
-
   /**
    * Retrieves the base URI of the distributor repository including the project namespace.
    *
@@ -268,7 +236,7 @@ public URI getDistributorMavenURI(String... notAvailableSolution) {
    */
   public URI getProjectMavenURI(String... notAvailableSolution) {
     if(projectMavenURI == null) {
-      URI distributorURI = getDistributorMavenURI(notAvailableSolution);
+      URI distributorURI = Util.getDistributorMavenURI(project, notAvailableSolution);
 
       projectMavenURI = Util.concatURI(
           distributorURI,

src/main/java/net/flintmc/gradle/manifest/tasks/PublishTaskBase.java

@@ -67,7 +67,7 @@ protected final void publish(URI uri, RequestBody requestBody) {
         .put(requestBody);
 
 
-    HttpHeaderCredentials credentials = Util.getPublishCredentials(
+    HttpHeaderCredentials credentials = Util.getDistributorCredentials(
         getProject(),
         true,
         "Set enablePublishing to false in the flint extension");

src/main/java/net/flintmc/gradle/maven/FlintResolutionStrategy.java

@@ -19,12 +19,14 @@
 
 package net.flintmc.gradle.maven;
 
-import com.google.common.base.Objects;
-import java.util.ArrayList;
-import java.util.List;
+import net.flintmc.gradle.extension.FlintGradleExtension;
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.ModuleVersionSelector;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+
 public class FlintResolutionStrategy {
 
   private static final FlintResolutionStrategy instance = new FlintResolutionStrategy();
@@ -54,8 +56,8 @@ public static FlintResolutionStrategy getInstance() {
   }
 
   /**
-   * Allows forcing certain versions of dependencies, including transitive dependencies. Appends new
-   * forced modules to be considered when resolving dependencies. It accepts following notations:
+   * Allows forcing certain versions of dependencies, including transitive dependencies. Appends new forced modules to
+   * be considered when resolving dependencies. It accepts following notations:
    *
    * <ul>
    *   <li>String in a format of: 'group:name:version', for example: 'org.gradle:gradle-core:1.0'
@@ -67,22 +69,22 @@ public static FlintResolutionStrategy getInstance() {
   public void forceDependency(Object moduleVersionSelectorNotation) {
     ForcedDependency forcedDependency = this.createForcedDependency(moduleVersionSelectorNotation);
 
-    if (forcedDependency == null) {
+    if(forcedDependency == null) {
       return;
     }
 
-    for (int index = 0; index < this.forcedDependencies.size(); index++) {
+    for(int index = 0; index < this.forcedDependencies.size(); index++) {
       ForcedDependency dependency = this.createForcedDependency(this.forcedDependencies.get(index));
 
-      if (dependency == null) {
+      if(dependency == null) {
         return;
       }
 
-      if (dependency.equals(forcedDependency)) {
+      if(dependency.equals(forcedDependency)) {
         return;
       }
 
-      if (dependency.nonVersionEquals(forcedDependency)) {
+      if(dependency.nonVersionEquals(forcedDependency)) {
         this.forcedDependencies.set(index, moduleVersionSelectorNotation);
         return;
       }
@@ -92,8 +94,8 @@ public void forceDependency(Object moduleVersionSelectorNotation) {
   }
 
   /**
-   * Allows forcing certain versions of dependencies, including transitive dependencies. Appends new
-   * forced modules to be considered when resolving dependencies. It accepts following notations:
+   * Allows forcing certain versions of dependencies, including transitive dependencies. Appends new forced modules to
+   * be considered when resolving dependencies. It accepts following notations:
    *
    * <ul>
    *   <li>String in a format of: 'group:name:version', for example: 'org.gradle:gradle-core:1.0'
@@ -104,47 +106,63 @@ public void forceDependency(Object moduleVersionSelectorNotation) {
    * @param moduleVersionSelectorNotations Typically group:name:version notations to append.
    */
   public void forceDependencies(Object... moduleVersionSelectorNotations) {
-    for (Object moduleVersionSelectorNotation : moduleVersionSelectorNotations) {
+    for(Object moduleVersionSelectorNotation : moduleVersionSelectorNotations) {
       this.forceDependency(moduleVersionSelectorNotation);
     }
   }
 
   /**
    * Forces a collection of dependencies on all configurations of the given {@code project}.
    *
-   * @param project The project for which the dependencies are to be enforced.
+   * @param project   The project for which the dependencies are to be enforced.
+   * @param extension The flint extension for the project
    */
-  public void forceResolutionStrategy(Project project) {
+  public void forceResolutionStrategy(Project project, FlintGradleExtension extension) {
+    String flintVersion = extension.getFlintVersion();
+
     project
         .getConfigurations()
         .forEach(
             configuration ->
                 configuration.resolutionStrategy(
                     resolutionStrategy -> {
                       forcedDependencies.forEach(resolutionStrategy::force);
+                      resolutionStrategy.eachDependency((details) -> {
+                        ModuleVersionSelector selector = details.getRequested();
+
+                        if(selector.getGroup().equals("net.flintmc") && !Objects.equals(selector.getVersion(), flintVersion)) {
+
+                          // Force the flint version to what is specified in the project
+                          details.useVersion(flintVersion);
+                          details.because(
+                              "Forcing net.flintmc dependency from " + selector.getVersion() + " to " +
+                                  flintVersion + " to ensure a consistent framework version " +
+                                  "[Automatically done by flint-gradle]");
+                        }
+                      });
                     }));
   }
 
   private ForcedDependency createForcedDependency(Object moduleVersionSelectorNotation) {
 
-    if (moduleVersionSelectorNotation instanceof String) {
+    if(moduleVersionSelectorNotation instanceof String) {
       String notation = (String) moduleVersionSelectorNotation;
 
-      if (!notation.contains(":")) {
+      if(!notation.contains(":")) {
         return null;
       }
 
       String[] split = notation.split(":");
 
-      if (split.length == 3) {
+      if(split.length == 3) {
 
         String group = split[0];
         String name = split[1];
         String version = split[2];
 
         return new ForcedDependency(group, name, version);
       }
-    } else if (moduleVersionSelectorNotation instanceof ModuleVersionSelector) {
+    } else if(moduleVersionSelectorNotation instanceof ModuleVersionSelector) {
       ModuleVersionSelector moduleVersionSelector =
           (ModuleVersionSelector) moduleVersionSelectorNotation;
       return new ForcedDependency(
@@ -180,25 +198,33 @@ public String getVersion() {
     }
 
     public boolean nonVersionEquals(Object o) {
-      if (this == o) return true;
-      if (o == null || getClass() != o.getClass()) return false;
+      if(this == o) {
+        return true;
+      }
+      if(o == null || getClass() != o.getClass()) {
+        return false;
+      }
       ForcedDependency that = (ForcedDependency) o;
-      return Objects.equal(group, that.group) && Objects.equal(name, that.name);
+      return Objects.equals(group, that.group) && Objects.equals(name, that.name);
     }
 
     @Override
     public boolean equals(Object o) {
-      if (this == o) return true;
-      if (o == null || getClass() != o.getClass()) return false;
+      if(this == o) {
+        return true;
+      }
+      if(o == null || getClass() != o.getClass()) {
+        return false;
+      }
       ForcedDependency that = (ForcedDependency) o;
-      return Objects.equal(group, that.group)
-          && Objects.equal(name, that.name)
-          && Objects.equal(version, that.version);
+      return Objects.equals(group, that.group)
+          && Objects.equals(name, that.name)
+          && Objects.equals(version, that.version);
     }
 
     @Override
     public int hashCode() {
-      return Objects.hashCode(group, name, version);
+      return Objects.hash(group, name, version);
     }
   }
 }

src/main/java/net/flintmc/gradle/patch/context/LocalPatchContextProvider.java

@@ -125,7 +125,7 @@ private void writeFile(PatchSingle patch, List<String> lines) throws IOException
       if (patch.getHunks().length == 0) {
         patch.getTargetFile().delete();
       } else {
-        byte[] content = Util.deserializeLines(patch.getHunks()[0].lines);
+        byte[] content = Util.decodeBase64Lines(patch.getHunks()[0].lines);
         this.copyStreamsCloseAll(
             new FileOutputStream(patch.getTargetFile()), new ByteArrayInputStream(content));
       }