1.8.1

Performance: Drastically improve mod pack extraction performance

Add built in mods system for some weird modrinth modpacks

Author: FlowArg

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'maven-publish'
 apply plugin: 'signing'
 
 group 'fr.flowarg'
-version '1.8.0'
+version '1.8.1'
 archivesBaseName = "flowupdater"
 
 java {
@@ -35,7 +35,7 @@ dependencies {
 
     // Only for internal tests
     testImplementation 'fr.flowarg:openlauncherlib:3.2.6'
-    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.3'
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.10.0'
 }
 
 artifacts {

src/main/java/fr/flowarg/flowupdater/FlowUpdater.java

@@ -36,7 +36,7 @@
 public class FlowUpdater
 {
     /** FlowUpdater's version string constant */
-    public static final String FU_VERSION = "1.8.0";
+    public static final String FU_VERSION = "1.8.1";
 
     /** Vanilla version's object to update/install */
     private final VanillaVersion vanillaVersion;

src/main/java/fr/flowarg/flowupdater/integrations/IntegrationManager.java

@@ -156,6 +156,7 @@ public void loadModrinthIntegration(Path dir, IModrinthFeaturesUser modrinthFeat
             this.progressCallback.step(Step.MOD_PACK);
             final ModrinthModPack modPack = modrinthIntegration.getCurseModPack(modPackInfo);
             this.logger.info(String.format("Loading mod pack: %s (%s).", modPack.getName(), modPack.getVersion()));
+            modrinthFeaturesUser.setModrinthModPack(modPack);
 
             for (Mod mod : modPack.getMods())
                 this.checkMod(mod, allModrinthMods, dir);

src/main/java/fr/flowarg/flowupdater/integrations/curseforgeintegration/CurseForgeIntegration.java

@@ -20,6 +20,7 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
 import java.util.*;
 import java.util.concurrent.ConcurrentLinkedQueue;
 import java.util.concurrent.Executors;
@@ -309,13 +310,7 @@ private void transferAndClose(@NotNull Path flPath, ZipFile zipFile, ZipEntry en
         if(Files.notExists(flPath.getParent()))
             Files.createDirectories(flPath.getParent());
 
-        try(OutputStream pathStream = Files.newOutputStream(flPath);
-            BufferedOutputStream fo = new BufferedOutputStream(pathStream);
-            InputStream is = zipFile.getInputStream(entry)) {
-
-            while (is.available() > 0)
-                fo.write(is.read());
-        }
+        Files.copy(zipFile.getInputStream(entry), flPath, StandardCopyOption.REPLACE_EXISTING);
     }
 
     private static class ProjectMod extends CurseFileInfo

src/main/java/fr/flowarg/flowupdater/integrations/modrinthintegration/IModrinthFeaturesUser.java

@@ -20,6 +20,18 @@ public interface IModrinthFeaturesUser
      */
     ModrinthModPackInfo getModrinthModPackInfo();
 
+    /**
+     * Get the modrinth mod pack.
+     * @return the modrinth mod pack.
+     */
+    ModrinthModPack getModrinthModPack();
+
+    /**
+     * Define the modrinth mod pack.
+     * @param modrinthModPack the modrinth mod pack.
+     */
+    void setModrinthModPack(ModrinthModPack modrinthModPack);
+
     /**
      * Define all modrinth mods to update.
      * @param modrinthMods modrinth mods to define.

src/main/java/fr/flowarg/flowupdater/integrations/modrinthintegration/ModrinthIntegration.java

@@ -23,6 +23,7 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
@@ -35,6 +36,8 @@ public class ModrinthIntegration extends Integration
     private static final String MODRINTH_VERSION_ENDPOINT = "version/{versionId}";
     private static final String MODRINTH_PROJECT_VERSION_ENDPOINT = "project/{projectId}/version";
 
+    private final List<Mod> builtInMods = new ArrayList<>();
+
     /**
      * Default constructor of a basic Integration.
      *
@@ -130,8 +133,8 @@ private void extractModPack(@NotNull Path out, boolean installExtFiles) throws E
         while (entries.hasMoreElements())
         {
             final ZipEntry entry = entries.nextElement();
-            final Path flPath = dirPath.resolve(StringUtils.empty(StringUtils.empty(entry.getName(), "client-overrides/"), "overrides/"));
             final String entryName = entry.getName();
+            final Path flPath = dirPath.resolve(StringUtils.empty(StringUtils.empty(entryName, "client-overrides/"), "overrides/"));
 
             if(entryName.equalsIgnoreCase("modrinth.index.json"))
             {
@@ -140,6 +143,15 @@ private void extractModPack(@NotNull Path out, boolean installExtFiles) throws E
                 continue;
             }
 
+            final String withoutOverrides = StringUtils.empty(StringUtils.empty(entryName, "overrides/"), "client-overrides/");
+
+            if(withoutOverrides.startsWith("mods/") || withoutOverrides.startsWith("mods\\"))
+            {
+                final String modName = withoutOverrides.substring(withoutOverrides.lastIndexOf('/') + 1);
+                final Mod mod = new Mod(modName, "", "", entry.getSize());
+                this.builtInMods.add(mod);
+            }
+
             if(!installExtFiles || Files.exists(flPath)) continue;
 
             if (flPath.getFileName().toString().endsWith(flPath.getFileSystem().getSeparator()))
@@ -163,7 +175,7 @@ private void extractModPack(@NotNull Path out, boolean installExtFiles) throws E
         final String modPackVersion = manifestObj.get("versionId").getAsString();
         final List<Mod> mods = this.parseManifest(manifestObj);
 
-        return new ModrinthModPack(modPackName, modPackVersion, mods);
+        return new ModrinthModPack(modPackName, modPackVersion, mods, this.builtInMods);
     }
 
     private @NotNull List<Mod> parseManifest(@NotNull JsonObject manifestObject)
@@ -178,7 +190,7 @@ private void extractModPack(@NotNull Path out, boolean installExtFiles) throws E
             if(file.getAsJsonObject("env").get("client").getAsString().equals("unsupported"))
                 return;
 
-            final String name = StringUtils.empty(file.get("path").getAsString(), "mods/");
+            final String name = StringUtils.empty(StringUtils.empty(file.get("path").getAsString(), "mods/"), "mods\\");
             final String downloadURL = file.getAsJsonArray("downloads").get(0).getAsString();
             final String sha1 = file.getAsJsonObject("hashes").get("sha1").getAsString();
             final long size = file.get("fileSize").getAsLong();
@@ -194,12 +206,6 @@ private void transferAndClose(@NotNull Path flPath, ZipFile zipFile, ZipEntry en
         if(Files.notExists(flPath.getParent()))
             Files.createDirectories(flPath.getParent());
 
-        try(OutputStream pathStream = Files.newOutputStream(flPath);
-            BufferedOutputStream fo = new BufferedOutputStream(pathStream);
-            InputStream is = zipFile.getInputStream(entry)) {
-
-            while (is.available() > 0)
-                fo.write(is.read());
-        }
+        Files.copy(zipFile.getInputStream(entry), flPath, StandardCopyOption.REPLACE_EXISTING);
     }
 }

src/main/java/fr/flowarg/flowupdater/integrations/modrinthintegration/ModrinthModPack.java

@@ -2,19 +2,27 @@
 
 import fr.flowarg.flowupdater.download.json.Mod;
 
+import java.util.ArrayList;
 import java.util.List;
 
 public class ModrinthModPack
 {
     private final String name;
     private final String version;
     private final List<Mod> mods;
+    private final List<Mod> builtInMods;
 
     ModrinthModPack(String name, String version, List<Mod> mods)
+    {
+        this(name, version, mods, new ArrayList<>());
+    }
+
+    ModrinthModPack(String name, String version, List<Mod> mods, List<Mod> builtInMods)
     {
         this.name = name;
         this.version = version;
         this.mods = mods;
+        this.builtInMods = builtInMods;
     }
 
     /**
@@ -44,4 +52,17 @@ public List<Mod> getMods()
     {
         return this.mods;
     }
+
+    /**
+     * Get the built-in mods in the mod pack.
+     * Built-in mods are mods directly put in the mods folder in the .mrpack file.
+     * They are not downloaded from a remote server.
+     * This is not a very good way to add mods because it disables some mod verification on these mods.
+     * We recommend mod pack creators to use the built-in mods feature only for mods that are not available remotely.
+     * @return the built-in mods in the mod pack.
+     */
+    public List<Mod> getBuiltInMods()
+    {
+        return this.builtInMods;
+    }
 }

src/main/java/fr/flowarg/flowupdater/utils/ModFileDeleter.java

@@ -2,6 +2,7 @@
 
 import fr.flowarg.flowio.FileUtils;
 import fr.flowarg.flowupdater.download.json.Mod;
+import fr.flowarg.flowupdater.integrations.modrinthintegration.ModrinthModPack;
 import fr.flowarg.flowupdater.integrations.optifineintegration.OptiFine;
 
 import java.io.IOException;
@@ -33,17 +34,32 @@ public ModFileDeleter(String... modsToIgnore)
      * Delete all bad files in the provided directory.
      * @param modsDir the mod's folder.
      * @param mods the mods list.
-     * @param optiFine the OptiFine object.
      * @throws Exception thrown if an error occurred
      */
-    public void delete(Path modsDir, List<Mod> mods, OptiFine optiFine) throws Exception
+    public void delete(Path modsDir, List<Mod> mods) throws Exception
+    {
+        this.delete(modsDir, mods, null, null);
+    }
+
+    /**
+     * Delete all bad files in the provided directory.
+     * @param modsDir the mod's folder.
+     * @param mods the mods list.
+     * @param optiFine the OptiFine object. (SPECIFIC USE CASE)
+     * @param modrinthModPack the modrinth mod pack. (SPECIFIC USE CASE)
+     * @throws Exception thrown if an error occurred
+     */
+    public void delete(Path modsDir, List<Mod> mods, OptiFine optiFine, ModrinthModPack modrinthModPack) throws Exception
     {
         if(!this.isUseFileDeleter()) return;
 
         final Set<Path> badFiles = new HashSet<>();
         final List<Path> verifiedFiles = new ArrayList<>();
         Arrays.stream(this.modsToIgnore).forEach(fileName -> verifiedFiles.add(modsDir.resolve(fileName)));
 
+        if(modrinthModPack != null)
+            modrinthModPack.getBuiltInMods().forEach(mod -> verifiedFiles.add(modsDir.resolve(mod.getName())));
+
         for(Path fileInDir : FileUtils.list(modsDir).stream().filter(path -> !Files.isDirectory(path)).collect(Collectors.toList()))
         {
             if(verifiedFiles.contains(fileInDir))

src/main/java/fr/flowarg/flowupdater/versions/AbstractForgeVersion.java

@@ -269,7 +269,7 @@ public void installMods(Path modsDir) throws Exception
             this.callback.update(this.downloadList.getDownloadInfo());
         }
 
-        this.fileDeleter.delete(modsDir, this.mods, ofObj);
+        this.fileDeleter.delete(modsDir, this.mods, ofObj, this.modrinthModPack);
     }
 
     /** This method packs the modified installer to a JAR file.

src/main/java/fr/flowarg/flowupdater/versions/AbstractModLoaderVersion.java

@@ -7,6 +7,7 @@
 import fr.flowarg.flowupdater.download.json.*;
 import fr.flowarg.flowupdater.integrations.curseforgeintegration.ICurseFeaturesUser;
 import fr.flowarg.flowupdater.integrations.modrinthintegration.IModrinthFeaturesUser;
+import fr.flowarg.flowupdater.integrations.modrinthintegration.ModrinthModPack;
 import fr.flowarg.flowupdater.utils.ModFileDeleter;
 import org.jetbrains.annotations.NotNull;
 
@@ -27,6 +28,7 @@ public abstract class AbstractModLoaderVersion implements ICurseFeaturesUser, IM
     protected DownloadList downloadList;
     protected IProgressCallback callback;
     protected String javaPath;
+    protected ModrinthModPack modrinthModPack;
 
     public AbstractModLoaderVersion(List<Mod> mods, String modLoaderVersion, List<CurseFileInfo> curseMods,
             List<ModrinthVersionInfo> modrinthMods, ModFileDeleter fileDeleter, CurseModPackInfo curseModPackInfo,
@@ -162,4 +164,16 @@ public ModFileDeleter getFileDeleter()
     {
         return this.fileDeleter;
     }
+
+    @Override
+    public void setModrinthModPack(ModrinthModPack modrinthModPack)
+    {
+        this.modrinthModPack = modrinthModPack;
+    }
+
+    @Override
+    public ModrinthModPack getModrinthModPack()
+    {
+        return this.modrinthModPack;
+    }
 }