Cleanup FileNameUtils and FileUtils a bit

Author: sakura-ryoko

src/main/java/fi/dy/masa/malilib/gui/interfaces/IDirectoryCache.java

@@ -5,6 +5,7 @@
 
 public interface IDirectoryCache
 {
+    // TODO -- Remove the file system; needs to deal with the FileFilter mechanism to make it compat with Path
     @Nullable
     File getCurrentDirectoryForContext(String context);
 

src/main/java/fi/dy/masa/malilib/gui/interfaces/IDirectoryNavigator.java

@@ -4,6 +4,7 @@
 
 public interface IDirectoryNavigator
 {
+    // TODO -- Remove the file system; needs to deal with the FileFilter mechanism to make it compat with Path
     File getCurrentDirectory();
 
     void switchToDirectory(File dir);

src/main/java/fi/dy/masa/malilib/gui/widgets/WidgetDirectoryNavigation.java

@@ -19,6 +19,7 @@
 
 public class WidgetDirectoryNavigation extends WidgetSearchBar
 {
+    // TODO -- Remove the file system; needs to deal with the FileFilter mechanism to make it compat with Path
     protected final File currentDir;
     protected final File rootDir;
     protected final IDirectoryNavigator navigator;

src/main/java/fi/dy/masa/malilib/gui/widgets/WidgetFileBrowserBase.java

@@ -22,6 +22,7 @@
 
 public abstract class WidgetFileBrowserBase extends WidgetListBase<DirectoryEntry, WidgetDirectoryEntry> implements IDirectoryNavigator
 {
+    // TODO -- Remove the file system; needs to deal with the FileFilter mechanism to make it compat with Path
     protected static final FileFilter DIRECTORY_FILTER = new FileFilterDirectories();
     public static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
 

src/main/java/fi/dy/masa/malilib/util/DirectoryCreator.java

@@ -8,6 +8,7 @@
 
 public class DirectoryCreator implements IStringConsumerFeedback
 {
+    // TODO -- Remove the file system; needs to deal with the FileFilter mechanism to make it compat with Path
     protected final File dir;
     @Nullable protected final IDirectoryNavigator navigator;
 

src/main/java/fi/dy/masa/malilib/util/FileNameUtils.java

@@ -5,12 +5,10 @@
 import java.util.Locale;
 import com.google.common.collect.ImmutableSet;
 import org.apache.commons.lang3.StringUtils;
-import org.jetbrains.annotations.ApiStatus;
 
 /**
  * Post-ReWrite code
  */
-@ApiStatus.Experimental
 public class FileNameUtils
 {
     public static final SimpleDateFormat DATE_TIME_FORMAT = new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss");

src/main/java/fi/dy/masa/malilib/util/FileUtils.java

@@ -1,19 +1,15 @@
 package fi.dy.masa.malilib.util;
 
-import javax.annotation.Nullable;
 import java.io.BufferedWriter;
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.*;
 import java.util.*;
 import java.util.function.Consumer;
 import java.util.function.Predicate;
-import com.google.common.collect.ImmutableSet;
-import net.minecraft.nbt.NbtCompound;
-import net.minecraft.nbt.NbtIo;
-import net.minecraft.nbt.NbtSizeTracker;
+import javax.annotation.Nullable;
+
 import fi.dy.masa.malilib.MaLiLib;
 import fi.dy.masa.malilib.config.value.FileWriteType;
 import fi.dy.masa.malilib.util.game.wrap.GameWrap;
@@ -27,29 +23,34 @@ public class FileUtils
     public static final Predicate<Path> ALWAYS_FALSE_FILEFILTER = p -> false;
     public static final Predicate<Path> ANY_FILE_FILEFILTER = Files::isRegularFile;
     public static final Predicate<Path> JSON_FILEFILTER = (f) -> Files.isRegularFile(f) && f.getFileName().toString().endsWith(".json");
-    private static final Set<Character> ILLEGAL_CHARACTERS = ImmutableSet.of( '/', '\n', '\r', '\t', '\0', '\f', '`', '?', '*', '\\', '<', '>', '|', '\"', ':' );
 
+    /**
+     * Please stop using the File object
+     * @return ()
+     */
+    @Deprecated(forRemoval = true)
     public static File getConfigDirectory()
     {
-        //return new File(MinecraftClient.getInstance().runDirectory, "config");
         return new File(GameWrap.getClient().runDirectory, "config");
     }
 
-    public static Path getConfigDirectoryAsPath()
+    /**
+     * Please stop using the File object
+     * @return ()
+     */
+    @Deprecated(forRemoval = true)
+    public static File getMinecraftDirectory()
     {
-        //return new File(MinecraftClient.getInstance().runDirectory, "config");
-        return GameWrap.getClient().runDirectory.toPath().resolve("config");
+        return GameWrap.getClient().runDirectory;
     }
 
-    public static File getMinecraftDirectory()
+    public static Path getConfigDirectoryAsPath()
     {
-        //return MinecraftClient.getInstance().runDirectory;
-        return GameWrap.getClient().runDirectory;
+        return GameWrap.getClient().runDirectory.toPath().resolve("config");
     }
 
-    public static Path getMinecraftDirectoryPath()
+    public static Path getMinecraftDirectoryAsPath()
     {
-        //return MinecraftClient.getInstance().runDirectory;
         return GameWrap.getClient().runDirectory.toPath();
     }
 
@@ -365,54 +366,51 @@ public static String getJoinedTrailingPathElements(File file, File rootPath, int
         return path;
     }
 
-    public static String getNameWithoutExtension(String name)
+    public static String getJoinedTrailingPathElements(Path file, Path rootPath, int maxStringLength, String separator)
     {
-        int i = name.lastIndexOf(".");
-        return i != -1 ? name.substring(0, i) : name;
-    }
+        StringBuilder path = new StringBuilder();
 
-    public static String generateSimpleSafeFileName(String name)
-    {
-        return name.toLowerCase(Locale.US).replaceAll("\\W", "_");
-    }
-
-    public static String generateSafeFileName(String name)
-    {
-        StringBuilder sb = new StringBuilder(name.length());
+        if (maxStringLength <= 0)
+        {
+            return "...";
+        }
 
-        for (int i = 0; i < name.length(); ++i)
+        while (file != null)
         {
-            char c = name.charAt(i);
+            String name = file.getFileName().toString();
 
-            if (ILLEGAL_CHARACTERS.contains(c) == false)
+            if ((path.length() == 0) == false)
             {
-                sb.append(c);
+                path.insert(0, name + separator);
+            }
+            else
+            {
+                path = new StringBuilder(name);
             }
-        }
 
-        // Some weird reserved windows keywords apparently... FFS >_>
-        return sb.toString().replaceAll("COM", "").replaceAll("PRN", "");
-    }
+            int len = path.length();
 
-    @Nullable
-    public static NbtCompound readNBTFile(File file)
-    {
-        if (file.exists() && file.isFile() && file.canRead())
-        {
-            try
+            if (len > maxStringLength)
             {
-                FileInputStream is = new FileInputStream(file);
-                NbtCompound nbt = NbtIo.readCompressed(is, NbtSizeTracker.ofUnlimitedBytes());
-                is.close();
-                return nbt;
+                path = new StringBuilder("... " + path.substring(len - maxStringLength, len));
+                break;
             }
-            catch (Exception e)
+
+            if (file.equals(rootPath))
             {
-                MaLiLib.LOGGER.warn("Failed to read NBT data from file '{}'", file.getAbsolutePath());
+                break;
             }
+
+            file = file.getParent();
         }
 
-        return null;
+        return path.toString();
+    }
+
+    public static String getNameWithoutExtension(String name)
+    {
+        int i = name.lastIndexOf(".");
+        return i != -1 ? name.substring(0, i) : name;
     }
 
     public static boolean writeDataToFile(final Path file, Consumer<BufferedWriter> dataWriter, FileWriteType writeType)

src/main/java/fi/dy/masa/malilib/util/StringUtils.java

@@ -587,9 +587,9 @@ public static String getWorldOrServerName()
                 // This used to be just MinecraftServer::getLevelName().
                 // Getting the name would now require an @Accessor for MinecraftServer.field_23784
                 String name = server.getSaveProperties().getLevelName();
-                // todo this was probably breaking non-US Locale file names
+                // this was breaking non-US Locale file names
                 //return FileUtils.generateSimpleSafeFileName(name);
-                return FileUtils.generateSafeFileName(name);
+                return FileNameUtils.generateSafeFileName(name);
             }
         }
         else
@@ -659,7 +659,7 @@ public static String getStorageFileName(boolean globalData, String prefix, Strin
             name = prefix + defaultName + suffix;
         }
 
-        return FileNameUtils.generateSimpleSafeFileName(name) + suffix;
+        return FileNameUtils.generateSafeFileName(name) + suffix;
     }
 
     public static String stringifyAddress(SocketAddress address)