Merge pull request #88 from isaki/pmp_group_filename_fix

Changes to PMP safe filenames.

Author: Squall-Leonhart

xivModdingFramework/Helpers/IOUtil.cs

@@ -40,11 +40,14 @@
 using System.Management;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
+using System.Text;
 
 namespace xivModdingFramework.Helpers
 {
     public static class IOUtil
     {
+        private static readonly HashSet<char> _InvalidFileNameChars = new(Path.GetInvalidFileNameChars());
+
         /// <summary>
         /// Compresses raw byte data.
         /// </summary>
@@ -729,16 +732,32 @@ public static bool IsDirectory(string path)
 
         public static string MakePathSafe(string fileName, bool makeLowercase = true)
         {
-            foreach (var c in Path.GetInvalidFileNameChars())
-            {
-                fileName = fileName.Replace(c, '-');
-            }
-            if (makeLowercase)
+            return IOUtil.MakePathSafe(fileName, '-', makeLowercase);
+        }
+
+        public static string MakePathSafe(string fileName, char rep, bool makeLowercase = true)
+        {
+            // This approach walks the string once, and hash lookups are O(1).
+            StringBuilder ret = new(fileName.Length);
+            foreach (var c in fileName)
             {
-                fileName = fileName.ToLower();
+                if (_InvalidFileNameChars.Contains(c))
+                {
+                    ret.Append(rep);
+                }
+                else if (makeLowercase)
+                {
+                    ret.Append(Char.ToLower(c));
+                }
+                else
+                {
+                    ret.Append(c);
+                }
             }
-            return fileName.Trim();
+
+            return ret.ToString().Trim();
         }
+
         public static void CopyFolder(string sourcePath, string targetPath)
         {
             sourcePath = MakeLongPath(sourcePath);
@@ -962,6 +981,5 @@ await Task.Run(async () =>
                 Trace.WriteLine(ex);
             }
         }
-
     }
 }

xivModdingFramework/Mods/FileTypes/PMP.cs

@@ -43,6 +43,9 @@ namespace xivModdingFramework.Mods.FileTypes.PMP
     public static class PMP
     {
         public const int _WriteFileVersion = 3;
+
+        private const char _PMPSafeNameReplacement = '_';
+
         private static bool _ImportActive = false;
         private static string _Source = null;
 
@@ -837,7 +840,7 @@ public static async Task WritePmp(PMPJson pmp, string workingDirectory, string z
 
             for(int i = 0; i < pmp.Groups.Count; i++)
             {
-                var gName = IOUtil.MakePathSafe(pmp.Groups[i].Name.ToLower());
+                var gName = PMP.MakePMPPathSafe(pmp.Groups[i].Name);
                 var groupPath = Path.Combine(workingDirectory, "group_" + (i+1).ToString("D3") + "_" + gName + ".json");
                 var groupString = JsonConvert.SerializeObject(pmp.Groups[i], Formatting.Indented);
                 File.WriteAllText(groupPath, groupString);
@@ -1283,9 +1286,18 @@ await Task.Run(async () =>
             return (seenMetadata.Values.ToList(), seenRgsps.Values.ToList(), otherManipulations);
         }
 
-    }
+        private static string MakePMPPathSafe(string fileName)
+        {
+            // This method enforces the naming scheme that penumbra expects for its json components.
+            if (fileName == ".")
+                return new(_PMPSafeNameReplacement, 1);
 
+            if (fileName == "..")
+                return new(_PMPSafeNameReplacement, 2);
 
+            return IOUtil.MakePathSafe(fileName.Normalize(NormalizationForm.FormKC), _PMPSafeNameReplacement, true);
+        }
+    }
 
     #region Penumbra Simple JSON Classes
     public class PMPJson