Add a Save As button to Forge mode (#98)

Author: LeafHacker

CHANGELOG.md

@@ -7,10 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Added full support for MultiMC installation. The MultiMC mode now creates an instance just like the Vanilla mode creates a profile.
+- Added a "Save As" dialog to the Forge installation mode and a matching CLI argument `--destination`. This replaces the previous "Install" button, but only for Forge mode.
 
 ### Changed
 - Reworked the way OptiFine is supported. Instead of searching for an installed OptiFine instance, the user provides us with an OptiFine installer jar.
 - `--minecraft-directory`'s aliases changed; `--launcher-dir` and `--launcher-directory` were added and `--mc-path` was removed.
+- In "Show Vanilla JSON" mode the "Install" button now says "Show JSON" instead.
 
 ## Removed
 - Minecraft Directory setting from the GUI. It is still present as a CLI option.

src/main/java/io/github/ImpactDevelopment/installer/Args.java

@@ -64,6 +64,9 @@ public class Args {
     @Parameter(names = {"--all"}, description = "Run on all Impact releases")
     public boolean all = false;
 
+    @Parameter(names = {"--out", "--destination", "--dest"}, description = "Where to output \"Save As\" style modes like \"Forge\".")
+    public String dest;
+
     @Parameter(names = {"--mc-dir", "--minecraft-dir", "--minecraft-directory", "--launcher-dir", "--launcher-directory"}, description = "Path to the Minecraft Launcher directory")
     public String mcPath;
 
@@ -116,12 +119,6 @@ public Args() {
     }
 
     public void apply(InstallationConfig config) {
-        if (mcPath != null) {
-            setDirectory(config, MinecraftDirectorySetting.INSTANCE, mcPath);
-        }
-        if (multimcPath != null) {
-            setDirectory(config, MultiMCDirectorySetting.INSTANCE, multimcPath);
-        }
         if (mode != null) {
             config.setSettingValue(InstallationModeSetting.INSTANCE, InstallationModeOptions.valueOf(mode.toUpperCase()));
         }
@@ -152,11 +149,20 @@ public void apply(InstallationConfig config) {
                 throw new IllegalArgumentException(optifine + " is not found");
             }
         }
+        if (mcPath != null) {
+            setPath(config, MinecraftDirectorySetting.INSTANCE, mcPath, true);
+        }
+        if (multimcPath != null) {
+            setPath(config, MultiMCDirectorySetting.INSTANCE, multimcPath, true);
+        }
+        if (dest != null) {
+            setPath(config, DestinationSetting.INSTANCE, dest, false);
+        }
     }
 
-    private void setDirectory(InstallationConfig config, Setting<Path> setting, String value) {
+    private void setPath(InstallationConfig config, Setting<Path> setting, String value, boolean mustBeDirectory) {
         Path path = Paths.get(value);
-        if (!Files.isDirectory(path)) {
+        if (mustBeDirectory && !Files.isDirectory(path)) {
             throw new IllegalStateException(path + " is not a directory");
         }
         config.setSettingValue(setting, path);

src/main/java/io/github/ImpactDevelopment/installer/gui/pages/MainPage.java

@@ -35,8 +35,10 @@
 import java.awt.event.ActionListener;
 import java.awt.event.KeyEvent;
 import java.net.URI;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Optional;
 
 import static io.github.ImpactDevelopment.installer.target.InstallationModeOptions.MULTIMC;
 import static io.github.ImpactDevelopment.installer.target.InstallationModeOptions.SHOWJSON;
@@ -57,9 +59,44 @@ public MainPage(AppWindow app) {
             default: addOptifineSetting(app);
         }
 
-        JButton install = new JButton("Install");
+        JButton install = new JButton(mode.getButtonText());
         install.addActionListener((ActionEvent) -> {
             try {
+                Optional<Path> destination = Optional.ofNullable(app.config.getSettingValue(DestinationSetting.INSTANCE));
+                if (destination.isPresent()) {
+                    Path dest = destination.get();
+                    // JFileChooser won't open in a directory unless it exists;
+                    // If destination is inside .minecraft and .minecraft exists, create the dest dir
+                    Path defaultLauncher = app.config.getSettingValue(MinecraftDirectorySetting.INSTANCE);
+                    if (Files.isDirectory(defaultLauncher) && dest.toAbsolutePath().startsWith(defaultLauncher.toAbsolutePath())) {
+                        Files.createDirectories(dest.getParent());
+                    }
+                    // Otherwise, find the nearest existing parent.
+                    // (we don't want to create random directories just to open a Save dialog)
+                    Path dir = dest;
+                    while (dir != null && !Files.isDirectory(dir)) {
+                        dir = dir.getParent();
+                    }
+                    // If we couldn't find a directory, set a default
+                    if (dir == null) {
+                        dir = OperatingSystem.getHome();
+                    }
+
+                    JFileChooser dialog = new JFileChooser(dir.toFile());
+                    dialog.setFileSelectionMode(JFileChooser.FILES_AND_DIRECTORIES);
+                    dialog.setSelectedFile(dest.toFile());
+                    switch (dialog.showSaveDialog(app)) {
+                        case JFileChooser.APPROVE_OPTION:
+                            // save to destination
+                            app.config.setSettingValue(DestinationSetting.INSTANCE, dialog.getSelectedFile().toPath());
+                            break;
+                        case JFileChooser.ERROR_OPTION:
+                            throw new RuntimeException("Unexpected error in save dialog");
+                        case JFileChooser.CANCEL_OPTION:
+                            return;
+                    }
+                }
+
                 String msg = app.config.execute();
 
                 // Special case if installing optifine in showJson mode

src/main/java/io/github/ImpactDevelopment/installer/setting/settings/DestinationSetting.java

@@ -0,0 +1,58 @@
+/*
+ * This file is part of Impact Installer.
+ *
+ * Copyright (C) 2019  ImpactDevelopment and contributors
+ *
+ * See the CONTRIBUTORS.md file for a list of copyright holders
+ *
+ * This library 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; version 2.1
+ * of the License.
+ *
+ * This library 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 library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package io.github.ImpactDevelopment.installer.setting.settings;
+
+import io.github.ImpactDevelopment.installer.impact.ImpactVersion;
+import io.github.ImpactDevelopment.installer.setting.InstallationConfig;
+import io.github.ImpactDevelopment.installer.setting.Setting;
+import io.github.ImpactDevelopment.installer.target.InstallationModeOptions;
+
+import java.nio.file.Path;
+
+public enum DestinationSetting implements Setting<Path> {
+    INSTANCE;
+
+    @Override
+    public Path getDefaultValue(InstallationConfig config) {
+        InstallationModeOptions mode = config.getSettingValue(InstallationModeSetting.INSTANCE);
+        switch (mode) {
+            case FORGE:
+            case FORGE_PLUS_LITELOADER:
+                Path minecraft = config.getSettingValue(MinecraftDirectorySetting.INSTANCE);
+                ImpactVersion version = config.getSettingValue(ImpactVersionSetting.INSTANCE);
+                return minecraft.resolve("mods").resolve(version.mcVersion).resolve("Impact" + "-" + version.getCombinedVersion() + ".jar");
+            default:
+                return null;
+        }
+    }
+
+    @Override
+    public boolean validSetting(InstallationConfig config, Path value) {
+        return true;
+    }
+
+    @Override
+    public String toString() {
+        return getClass().getSimpleName();
+    }
+}

src/main/java/io/github/ImpactDevelopment/installer/target/InstallationModeOptions.java

@@ -29,19 +29,23 @@
 import java.util.function.Function;
 
 public enum InstallationModeOptions {
-    VANILLA(Vanilla::new, true),
-    FORGE(opt -> new Forge(opt, false), true),
-    FORGE_PLUS_LITELOADER(opt -> new Forge(opt, true), true),
-    VALIDATE(Validate::new, false),
-    MULTIMC(MultiMC::new, true),
-    SHOWJSON(ShowJSON::new, true);
+    VANILLA("Vanilla", "Install", true, Vanilla::new),
+    FORGE("Forge", "Save As", true, opt -> new Forge(opt, false)),
+    FORGE_PLUS_LITELOADER("Forge + Liteloader", "Save As", true, opt -> new Forge(opt, true)),
+    VALIDATE("Validate Vanilla version", "Validate", false, Validate::new),
+    MULTIMC("MultiMC", "Install", true, MultiMC::new),
+    SHOWJSON("Show Vanilla JSON", "Show JSON", true, ShowJSON::new);
 
-    InstallationModeOptions(Function<InstallationConfig, InstallationMode> mode, boolean showInGUI) {
+    InstallationModeOptions(String name, String buttonText, boolean showInGUI, Function<InstallationConfig, InstallationMode> mode) {
         this.mode = mode;
+        this.name = name;
+        this.buttonText = buttonText;
         this.showInGUI = showInGUI;
     }
 
     public final Function<InstallationConfig, InstallationMode> mode;
+    private final String name;
+    private final String buttonText;
     public final boolean showInGUI;
 
     public boolean supports(ImpactVersion impact) {
@@ -54,25 +58,12 @@ public boolean supports(ImpactVersion impact) {
         }
     }
 
+    public String getButtonText() {
+        return buttonText;
+    }
+
     @Override
     public String toString() {
-        // incredibly based code
-        // this is oof NGL :eyes:
-        switch (this) {
-            case VANILLA:
-                return "Vanilla";
-            case SHOWJSON:
-                return "Show Vanilla JSON";
-            case MULTIMC:
-                return "MultiMC";
-            case FORGE:
-                return "Forge";
-            case FORGE_PLUS_LITELOADER:
-                return "Forge + Liteloader";
-            case VALIDATE:
-                return "Validate Vanilla version";
-            default:
-                return "Unknown";
-        }
+        return name;
     }
 }

src/main/java/io/github/ImpactDevelopment/installer/target/targets/Forge.java

@@ -25,6 +25,7 @@
 import io.github.ImpactDevelopment.installer.impact.ImpactJsonVersion;
 import io.github.ImpactDevelopment.installer.libraries.ILibrary;
 import io.github.ImpactDevelopment.installer.setting.InstallationConfig;
+import io.github.ImpactDevelopment.installer.setting.settings.DestinationSetting;
 import io.github.ImpactDevelopment.installer.setting.settings.ImpactVersionSetting;
 import io.github.ImpactDevelopment.installer.setting.settings.MinecraftDirectorySetting;
 import io.github.ImpactDevelopment.installer.target.InstallationMode;
@@ -42,8 +43,10 @@
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.util.HashSet;
+import java.util.List;
 import java.util.jar.JarEntry;
 import java.util.jar.JarOutputStream;
+import java.util.stream.Collectors;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 
@@ -60,22 +63,26 @@ public Forge(InstallationConfig config, boolean liteloaderSupport) {
     }
 
     @Override
-    public String apply() {
-        Path out = config.getSettingValue(MinecraftDirectorySetting.INSTANCE).resolve("mods").resolve(version.mcVersion).resolve(version.name + "-" + version.version + "-" + version.mcVersion + ".jar");
+    public String apply() throws IOException {
+        Path out = config.getSettingValue(DestinationSetting.INSTANCE);
+
+        if (Files.isDirectory(out)) {
+            out = out.resolve(version.name + "-" + version.version + "-" + version.mcVersion + ".jar");
+        }
 
         if (!Files.exists(out.getParent())) {
-            try {
-                Files.createDirectories(out.getParent());
-            } catch (IOException e) {
-                e.printStackTrace();
-            }
+            Files.createDirectories(out.getParent());
         }
 
         if (liteloaderSupport) {
             JOptionPane.showMessageDialog(null, "This Forge jar will ONLY work with Liteloader + Forge, not with either on their own.\nIf you don't have liteloader, use the Forge option instead!\nIf you change your mind and just want Forge (no liteloader), you will need to reinstall Impact with the correct option!", "IMPORTANT", JOptionPane.INFORMATION_MESSAGE);
         }
 
-        Tracky.persist(config.getSettingValue(MinecraftDirectorySetting.INSTANCE));
+        Path defaultLauncher = config.getSettingValue(MinecraftDirectorySetting.INSTANCE);
+        if (Files.isDirectory(defaultLauncher)) {
+            Tracky.persist(defaultLauncher);
+        }
+
         HashSet<String> fileNames = new HashSet<>();
         try (JarOutputStream jarOut = new JarOutputStream(new FileOutputStream(out.toFile()))) {
             for (ILibrary library : version.resolveLibraries(config)) {
@@ -122,21 +129,32 @@ public String apply() {
             throw new RuntimeException(e);
         }
 
-        // Remove other Impact forge jars
+        // Look for other Impact forge jars
         try {
-            Files.list(out.getParent())
-                    .filter(f -> !f.equals(out))
+            final Path finalOut = out; //Variable used in lambda expression should be final or effectively final
+            List<Path> conflicts = Files.list(out.getParent())
+                    .filter(f -> !f.equals(finalOut))
                     .filter(f -> f.getFileName().toString().startsWith("Impact-"))
                     .filter(f -> f.getFileName().toString().endsWith(".jar"))
-                    .forEach(f -> {
-                        try {
-                            JOptionPane.showMessageDialog(null, "Replacing " + f, "\uD83D\uDE0E", JOptionPane.INFORMATION_MESSAGE);
-                            Files.delete(f);
-                        } catch (IOException e) {
-                            JOptionPane.showMessageDialog(null, "Failed to remove " + f, "\uD83D\uDE0E", JOptionPane.ERROR_MESSAGE);
-                            e.printStackTrace();
+                    .collect(Collectors.toList());
+
+            // If we find any Impact jars, warn the user and ask to delete them
+            if (!conflicts.isEmpty()) {
+                List<String> names = conflicts.stream().map(Path::getFileName).map(Path::toString).collect(Collectors.toList());
+                JOptionPane.showMessageDialog(null, "Warning: Having multiple Impact mods installed will cause errors:\n" + String.join("\n", names), "\uD83D\uDE0E", JOptionPane.WARNING_MESSAGE);
+
+                conflicts.forEach(conflict -> {
+                        if (JOptionPane.YES_OPTION == JOptionPane.showConfirmDialog(null, "Would you like to remove " + conflict.getFileName() + "?", "\uD83D\uDE0E", JOptionPane.YES_NO_OPTION)) {
+                            try {
+                                Files.delete(conflict);
+                                JOptionPane.showMessageDialog(null, "Removed " + conflict, "\uD83D\uDE0E", JOptionPane.INFORMATION_MESSAGE);
+                            } catch (IOException e) {
+                                JOptionPane.showMessageDialog(null, "Failed to remove " + conflict.getFileName() + ":\n" + e.getMessage(), "\uD83D\uDE0E", JOptionPane.ERROR_MESSAGE);
+                                e.printStackTrace();
+                            }
                         }
-                    });
+                });
+            }
         } catch (IOException e) {
             JOptionPane.showMessageDialog(null, "Error while checking for older Impact Forge installations: " + e.getLocalizedMessage(), "\uD83D\uDE0E", JOptionPane.ERROR_MESSAGE);
             e.printStackTrace();