Fix terminal input when ran with gui, improve non-overwritable file handling

Author: Patbox

build.gradle

@@ -2,7 +2,7 @@ import kotlin.jvm.functions.Function1
 
 plugins {
     id 'com.gradleup.shadow' version '8.3.5'
-    id 'xyz.wagyourtail.jvmdowngrader' version '1.3.0-SNAPSHOT'
+    id 'xyz.wagyourtail.jvmdowngrader' version '1.2.2'
     id 'java'
     id 'maven-publish'
 }

changelog-next

@@ -1,6 +1,8 @@
 - Added simple UI visible when running the jar directly on systems with graphics.
   - It will be closed once Minecraft opens it's own server window.
   - Can be disabled by providing `--noGui` or `noGui` option, just like vanilla game.
+- Modpack info files can now define non-overwritable files (prevents' modification if they already exist).
+- You can now add custom non-overwritable files/folders as a new-line separated list in `lockedpaths.txt` file in main server directory.
 - When running standalone and selecting a project, it now validates if it's actually a modpack.
 - When providing modpack slug/link, you can force it to always search by prefixing the input with question mark.
 - Removed `mrpack4server` text from log prefix.

src/main/java/eu/pb4/forgefx/S.java

@@ -120,7 +120,8 @@ public static void gc() {
     }
 
     public static void runFinalization() {
-       System.runFinalization();
+        //noinspection removal
+        System.runFinalization();
     }
 
     public static void load(String filename) {

src/main/java/eu/pb4/mrpackserver/Main.java

@@ -32,7 +32,11 @@ public static void main(String[] args) throws Throwable {
         var modpackInfo = Utils.resolveModpackInfo(runPath);
 
         if (!noGui) {
-            InstallerGui.setup(modpackInfo);
+            try {
+                InstallerGui.setup(modpackInfo);
+            } catch (Throwable e) {
+                Logger.error("Tried to open terminal ui, but it failed!", e);
+            }
         }
 
         if (modpackInfo == null) {

src/main/java/eu/pb4/mrpackserver/format/ModpackInfo.java

@@ -22,6 +22,8 @@ public class ModpackInfo {
     public String versionId = "";
     @SerializedName("whitelisted_domains")
     public List<String> whitelistedDomains = new ArrayList<>();
+    @SerializedName("non_overwritable_paths")
+    public List<String> nonOverwritablePaths = new ArrayList<>();
     @Nullable
     public String sha512 = null;
     @Nullable
@@ -37,6 +39,9 @@ public class ModpackInfo {
     @Nullable
     public String internalFlavor = null;
 
+    @SerializedName("skip_java_version_check")
+    public Boolean skipJavaVersionCheck = null;
+
     public boolean isValid() {
         return !this.projectId.isBlank() && !this.versionId.isBlank();
     }

src/main/java/eu/pb4/mrpackserver/installer/MrPackInstaller.java

@@ -20,13 +20,14 @@ public class MrPackInstaller {
     private final Path destinationOldModified;
     private final InstanceInfo currentInstanceData;
     private final Set<String> whitelistedDomains;
+    private final HashSet<String> nonOverwritablePaths;
     @Nullable
     private String newLauncher;
     @Nullable
     private Installer installer;
     private boolean forceSystemClasspath = false;
 
-    public MrPackInstaller(Path source, ModpackIndex index, Path destination, InstanceInfo data, HashMap<String, HashData> hashes, Set<String> whitelistedDomains) throws IOException {
+    public MrPackInstaller(Path source, ModpackIndex index, Path destination, InstanceInfo data, HashMap<String, HashData> hashes, Set<String> whitelistedDomains, HashSet<String> nonOverwritablePaths) throws IOException {
         this.source = source;
         this.index = index;
         this.currentInstanceData = data;
@@ -38,6 +39,7 @@ public MrPackInstaller(Path source, ModpackIndex index, Path destination, Instan
         this.newHashes = new HashMap<>();
 
         this.whitelistedDomains = whitelistedDomains;
+        this.nonOverwritablePaths = nonOverwritablePaths;
     }
 
     public void prepareFolders() throws IOException {
@@ -52,13 +54,14 @@ public void extractIncluded(Map<String, HashData> existingHashes) throws IOExcep
                 Files.walkFileTree(path, new FileVisitor<Path>() {
                     @Override
                     public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
-                        var p = destination.resolve(path.relativize(dir).toString()).normalize();
+                        var local = path.relativize(dir).toString();
+                        var p = destination.resolve(local).normalize();
                         if (!p.startsWith(destination.toAbsolutePath())) {
-                            Logger.error("Modpack contains files, that are placed outside of server's root! Found '%s'", path.relativize(dir).toString());
+                            Logger.error("Modpack contains files, that are placed outside of server's root! Found '%s'", local);
                             return FileVisitResult.TERMINATE;
                         }
 
-                        if (Constants.NON_OVERWRITABLE.contains(p.toString()) && Files.exists(p)) {
+                        if (nonOverwritablePaths.contains(local) && Files.exists(p)) {
                             Logger.warn("Skipping non-overwritable path: %s", path);
                             return FileVisitResult.SKIP_SUBTREE;
                         }
@@ -75,7 +78,7 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO
                             return FileVisitResult.TERMINATE;
                         }
 
-                        if (Constants.NON_OVERWRITABLE.contains(outPath.toString()) && Files.exists(file)) {
+                        if (nonOverwritablePaths.contains(local) && Files.exists(file)) {
                             Logger.warn("Skipping non-overwritable file: %s", path);
                             return FileVisitResult.CONTINUE;
                         }
@@ -241,6 +244,8 @@ public void requestDownloads(FileDownloader downloader, Map<String, HashData> ha
 
         for (var file : this.index.files) {
             var currentHash = hashExisting.remove(file.path);
+            var path = this.destination.resolve(file.path);
+
             if (currentHash != null) {
                 var newHash = HashData.read(Constants.MODRINTH_HASH, file.hashes);
 
@@ -250,6 +255,10 @@ public void requestDownloads(FileDownloader downloader, Map<String, HashData> ha
                 } else if (currentHash.equals(newHash)) {
                     this.newHashes.put(file.path, newHash);
                     continue;
+                } else if (nonOverwritablePaths.contains(file.path) && Files.exists(path)) {
+                    Logger.warn("Skipping non-overwritable file: %s", file.path);
+                    this.newHashes.put(file.path, this.oldHashes.get(file.path));
+                    continue;
                 } else if (currentHash.equals(this.oldHashes.get(file.path))) {
                     Files.deleteIfExists(this.destination.resolve(file.path));
                 } else {
@@ -258,6 +267,9 @@ public void requestDownloads(FileDownloader downloader, Map<String, HashData> ha
                     Logger.info("File '%s' was modified, but modpack required it to be updated! Moving it to '%s'", file.path, "old_modified_files/" + file.path);
                     Files.deleteIfExists(this.destination.resolve(file.path));
                 }
+            } else if (nonOverwritablePaths.contains(file.path) && Files.exists(path)) {
+                Logger.warn("Skipping non-overwritable file: %s", file.path);
+                continue;
             }
 
             for (var url : file.downloads) {
@@ -266,7 +278,6 @@ public void requestDownloads(FileDownloader downloader, Map<String, HashData> ha
                 }
             }
 
-            var path = this.destination.resolve(file.path);
             if (Files.exists(path)) {
                 Files.createDirectories(this.destinationOldModified.resolve(file.path).getParent());
                 Files.deleteIfExists(this.destinationOldModified.resolve(file.path));

src/main/java/eu/pb4/mrpackserver/util/Constants.java

@@ -18,14 +18,15 @@ public class Constants {
     public static final int DOWNLOAD_UPDATE_TIME = 1500;
     public static final int DOWNLOAD_CHUNK_SIZE = 512;
     public static final String DATA_FOLDER = ".mrpack4server";
+    public static final String CUSTOM_NON_OVERWRITABLE_LIST = "lockedpaths.txt";
 
     public static final String FABRIC_INSTALLER_VERSIONS = "https://meta.fabricmc.net/v2/versions/installer";
     public static final String MODRINTH_API = "https://api.modrinth.com/v2";
     public static final String MODRINTH_API_VERSIONS = MODRINTH_API + "/project/{PROJECT_ID}/version";
     public static final List<String> OVERWRITES = List.of("/overrides", "/server_overrides");
-    public static final List<String> NON_OVERWRITABLE = List.of("server.properties", "world", DATA_FOLDER);
+    public static final List<String> DEFAULT_NON_OVERWRITABLE = List.of("server.properties", "world", DATA_FOLDER, CUSTOM_NON_OVERWRITABLE_LIST);
 
-    public static final Set<String> WHITELISTED_URLS = Set.of(
+    public static final Set<String> DEFAULT_WHITELISTED_URLS = Set.of(
             "cdn.modrinth.com",
             "github.com",
             "raw.githubusercontent.com",

src/main/java/eu/pb4/mrpackserver/util/InstallerGui.java

@@ -14,20 +14,18 @@
 import java.awt.event.WindowEvent;
 import java.io.*;
 import java.nio.charset.Charset;
-import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 
 public class InstallerGui extends JComponent {
     private static final Font FONT_MONOSPACE = new Font("Monospaced", Font.PLAIN, 12);
     private final OutputStream logger;
     private final Charset charset;
-    private PrintStream oldOut;
-    private PrintStream oldErr;
-    private InputStream oldIn;
+    private final PrintStream oldOut;
+    private final PrintStream oldErr;
+    private final InputStream oldIn;
     private final AppendableInputStream in = new AppendableInputStream();
     private final JFrame frame;
     private JTextArea logBox;
-    private JScrollPane scrollPane;
     private boolean closed;
 
     public static InstallerGui instance = null;
@@ -58,7 +56,7 @@ public void write(int b) {
 
         System.setOut(new PrintStream(new DoubleOutputStream(System.out, logger), false, this.charset));
         System.setErr(new PrintStream(new DoubleOutputStream(System.err, logger), false, this.charset));
-        System.setIn(System.console() != null ? new DoubleInputStream(System.in, this.in) : this.in);
+        System.setIn(System.console() != null ? new DoubleWaitingInputStream(System.in, this.in) : this.in);
 
         instance = this;
     }
@@ -128,13 +126,13 @@ private Component createConsole() {
         var panel = new JPanel(new BorderLayout());
         this.logBox = new JTextArea();
         this.logBox.setFocusable(false);
+        this.logBox.setLineWrap(true);
         var caret = new DefaultCaret();
         caret.setVisible(false);
         //caret.setUpdatePolicy(DefaultCaret.NEVER_UPDATE);
         this.logBox.setCaret(caret);
 
         var scroll = new JScrollPane(logBox, ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS, ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED);
-        this.scrollPane = scroll;
 
         logBox.setEditable(false);
         logBox.setFont(FONT_MONOSPACE);
@@ -217,18 +215,56 @@ public void append(byte[] arr) {
         }
     }
 
-    private static class DoubleInputStream extends InputStream {
+    private static class DoubleWaitingInputStream extends InputStream {
         private final InputStream out;
         private final InputStream out2;
 
-        public DoubleInputStream(InputStream out, InputStream out2) {
+        public DoubleWaitingInputStream(InputStream out, InputStream out2) {
             this.out = out;
             this.out2 = out2;
         }
 
         @Override
         public int read() throws IOException {
-            return this.out.available() > this.out2.available() ? this.out.read() : this.out2.read();
+            var stream = getStream();
+            if (stream != null) {
+                return stream.read();
+            }
+            return -1;
+        }
+
+        @Override
+        public int read(@NotNull byte[] b) throws IOException {
+            var stream = getStream();
+            if (stream != null) {
+                return stream.read(b);
+            }
+            return 0;
+        }
+
+        @Override
+        public int read(@NotNull byte[] b, int off, int len) throws IOException {
+            var stream = getStream();
+            if (stream != null) {
+                return stream.read(b, off, len);
+            }
+            return 0;
+        }
+
+        private InputStream getStream() throws IOException {
+            while (true) {
+                if (this.out.available() > 0) {
+                    return this.out;
+                }
+                if (this.out2.available() > 0) {
+                    return this.out2;
+                }
+                try {
+                    Thread.sleep(1);
+                } catch (InterruptedException e) {
+                    return null;
+                }
+            }
         }
 
         @Override
@@ -277,7 +313,7 @@ public void close() throws IOException {
         }
     }
 
-    public void handleForgeFix() {
+    /*public void handleForgeFix() {
         Logger.warn("Forge on 1.16.5 and older breaks mrpack4server's initial log screen.");
         Logger.warn("You can safely close it without stopping the server.");
         var currOut = System.out;
@@ -313,5 +349,5 @@ public void handleForgeFix() {
         } catch (Throwable e) {
             Logger.error("Failed to apply forge logging fix!", e);
         }
-    }
+    }*/
 }

src/main/java/eu/pb4/mrpackserver/util/Utils.java

@@ -139,14 +139,26 @@ static InstallResult checkAndSetupModpack(ModpackInfo modpackInfo, InstanceInfo
                 hashes = Utils.GSON_MAIN.fromJson(Files.readString(hashPath), new TypeToken<HashMap<String, HashData>>() {}.getType());
             }
             var whitelistedDomains = new HashSet<String>();
-            whitelistedDomains.addAll(Constants.WHITELISTED_URLS);
+            whitelistedDomains.addAll(Constants.DEFAULT_WHITELISTED_URLS);
             whitelistedDomains.addAll(modpackInfo.whitelistedDomains);
+            var nonOverwritablePaths = new HashSet<String>();
+            nonOverwritablePaths.addAll(Constants.DEFAULT_NON_OVERWRITABLE);
+            nonOverwritablePaths.addAll(modpackInfo.nonOverwritablePaths);
+
+            var customNonOverwritable = currentDir.resolve(Constants.CUSTOM_NON_OVERWRITABLE_LIST);
+            try {
+                if (Files.exists(customNonOverwritable)) {
+                    nonOverwritablePaths.addAll(Files.readAllLines(customNonOverwritable));
+                }
+            } catch (Throwable ignored) {
+
+            }
 
             Logger.info("Starting %s of %s (%s)", hashes.isEmpty() ? "installation" : "update", modpackInfo.getDisplayName(), modpackInfo.getDisplayVersion());
 
-            var handler = new MrPackInstaller(zip.getPath(""), index, currentDir, instance, hashes, whitelistedDomains);
+            var handler = new MrPackInstaller(zip.getPath(""), index, currentDir, instance, hashes, whitelistedDomains, nonOverwritablePaths);
 
-            if (!handler.checkJavaVersion()) {
+            if (modpackInfo.skipJavaVersionCheck != Boolean.TRUE && !handler.checkJavaVersion()) {
                 return null;
             }
 
@@ -394,8 +406,13 @@ static void configureModpack(Path runPath) throws IOException, InterruptedExcept
                 }
             } else {
                 var client = Utils.createHttpClient();
-                var res = data.charAt(0) == '?' ? null : client.send(Utils.createGetRequest(URI.create(Constants.MODRINTH_API + "/project/" + URLEncoder.encode(data, StandardCharsets.UTF_8))), HttpResponse.BodyHandlers.ofString());
-
+                HttpResponse<String> res;
+                if (data.charAt(0) == '?') {
+                    data = data.substring(1);
+                    res = null;
+                } else {
+                    res = client.send(Utils.createGetRequest(URI.create(Constants.MODRINTH_API + "/project/" + URLEncoder.encode(data, StandardCharsets.UTF_8))), HttpResponse.BodyHandlers.ofString());
+                }
                 boolean foundProject = false;
                 if (res != null && res.statusCode() == 200) {
                     var project = ModrinthProjectData.read(res.body());