Update 2.2.0.0

Author: KoraLyn

xivModdingFramework/Cache/XivCache.cs

@@ -348,7 +348,7 @@ public static bool IsChildOf(this XivRace possibleChild, XivRace possibleParent,
         }
 
         /// <summary>
-        /// Determines if this race is a parent of a nother given race or not.
+        /// Determines if this race is a parent of another given race or not.
         /// If the values are the same, it is considered TRUE by default.
         /// </summary>
         /// <param name="possibleParent"></param>
@@ -377,6 +377,35 @@ public static bool IsParentOf(this XivRace possibleParent, XivRace possibleChild
 
         }
 
+        /// <summary>
+        /// Determines if this race is a direct parent of another given race or not.
+        /// If the values are the same, it is considered TRUE by default.
+        /// </summary>
+        /// <param name="possibleParent"></param>
+        /// <param name="possibleChild"></param>
+        /// <returns></returns>
+        public static bool IsDirectParentOf(this XivRace possibleParent, XivRace possibleChild, bool allowSame = true)
+        {
+            CheckTree();
+            if (possibleChild == possibleParent && allowSame)
+            {
+                return true;
+            }
+
+            var node = GetNode(possibleChild);
+
+            if (node?.Parent != null)
+            {
+                node = node.Parent;
+                if (node.Race == possibleParent)
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
         /// <summary>
         /// Retrieves the tree node for the given race.
         /// </summary>
@@ -470,6 +499,25 @@ public static string GetSkinPath(this XivRace startingRace, int body = 1, string
     /// </summary>
     public static class XivRaces
     {
+        public static readonly List<XivRace> PlayableRaces = new List<XivRace>() {
+            XivRace.Hyur_Midlander_Male,
+            XivRace.Hyur_Midlander_Female,
+            XivRace.Hyur_Highlander_Male,
+            XivRace.Hyur_Highlander_Female,
+            XivRace.Elezen_Male,
+            XivRace.Elezen_Female,
+            XivRace.Miqote_Male,
+            XivRace.Miqote_Female,
+            XivRace.Roegadyn_Male,
+            XivRace.Roegadyn_Female,
+            XivRace.Lalafell_Male,
+            XivRace.Lalafell_Female,
+            XivRace.AuRa_Male,
+            XivRace.AuRa_Female,
+            XivRace.Hrothgar,
+            XivRace.Viera,
+        };
+
         /// <summary>
         /// Gets the description from the enum value, in this case the Race Code
         /// </summary>

xivModdingFramework/Cache/XivDependencyGraph.cs

@@ -3,6 +3,7 @@
 using System;
 using System.Collections.Generic;
 using System.Text;
+using System.Text.RegularExpressions;
 
 namespace xivModdingFramework.Helpers
 {
@@ -13,5 +14,12 @@ public static class Constants
         /// The alphabet.  Now in character array form.
         /// </summary>
         public static readonly char[] Alphabet = { 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z' };
+        public static string BinaryOffsetMarker = "::";
+
+
+
+        // This commedically long regex validates URL strings.
+        // Came from - https://mathiasbynens.be/demo/url-regex (@scottgonzales version)
+        public static readonly Regex UrlValidationRegex = new Regex("#([a-z]([a-z]|\\d|\\+|-|\\.)*):(\\/\\/(((([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:)*@)?((\\[(|(v[\\da-f]{1,}\\.(([a-z]|\\d|-|\\.|_|~)|[!\\$&'\\(\\)\\*\\+,;=]|:)+))\\])|((\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])\\.(\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])\\.(\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])\\.(\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5]))|(([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=])*)(:\\d*)?)(\\/(([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)*)*|(\\/((([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)+(\\/(([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)*)*)?)|((([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)+(\\/(([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)*)*)|((([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)){0})(\\?((([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)|[\\xE000-\\xF8FF]|\\/|\\?)*)?(\\#((([a-z]|\\d|-|\\.|_|~|[\\x00A0-\\xD7FF\\xF900-\\xFDCF\\xFDF0-\\xFFEF])|(%[\\da-f]{2})|[!\\$&'\\(\\)\\*\\+,;=]|:|@)|\\/|\\?)*)?#iS");
     }
 }

xivModdingFramework/General/Enums/XivRace.cs

@@ -25,8 +25,6 @@ namespace xivModdingFramework.Helpers
     /// </summary>
     public class HashGenerator
     {
-        private static int _dwCrc;
-
         private static readonly uint[] CrcTable1 = new uint[]{
             0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832,
             0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, 0x1DB71064, 0x6AB020F2,
@@ -165,6 +163,7 @@ private static int ComputeCRC(byte[] ecxBytes, int offset)
 
         private static int ComputeCRC(byte[] ecxBytes, int offset, int cbLength)
         {
+            int _dwCrc;
             using (var stream = new MemoryStream(ecxBytes))
             {
                 using (var reader = new BinaryReader(stream))

xivModdingFramework/Helpers/Constants.cs

@@ -133,6 +133,8 @@ public static string MakeItemSavePath(IItem item, DirectoryInfo saveDirectory, X
 
             return path;
         }
+
+
         public static XivRace GetRaceFromPath(string path)
         {
             if(path == null)
@@ -152,7 +154,7 @@ public static XivRace GetRaceFromPath(string path)
             }
             else if (path.Contains(".tex") || path.Contains(".mdl") || path.Contains(".atex"))
             {
-                if (path.Contains("accessory") || path.Contains("weapon") || path.Contains("/common/"))
+                if (path.Contains("weapon") || path.Contains("/common/"))
                 {
                     xivRace = XivRace.All_Races;
                 }
@@ -250,5 +252,46 @@ public static XivDataFile GetDataFileFromPath(string path)
 
             throw new Exception("Could not resolve data file - Invalid internal FFXIV path.");
         }
+
+        /// <summary>
+        /// Cleans a given string of unusual or potentially invalid characters for most use cases, particularly URLs.
+        /// </summary>
+        /// <param name="st"></param>
+        /// <returns></returns>
+        public static string CleanString(string st)
+        {
+            if(st == null)
+            {
+                return "";
+            }
+
+            
+            const string invalids = "!\"#$%&'()*+,-./@:;<=>[\\]^_`{|}~";
+
+            st = st.Trim();
+            foreach (var c in invalids)
+            {
+                st.Replace(c.ToString(), "");
+            }
+
+            return st;
+        }
+
+        /// <summary>
+        /// Cleans up and validates a string to ensure it's a valid URL.
+        /// If the given URL is totally invalid, NULL is returned.
+        /// </summary>
+        /// <param name="url"></param>
+        /// <returns></returns>
+        public static string ValidateUrl(string url)
+        {
+            url = CleanString(url);
+            if (Constants.UrlValidationRegex.IsMatch(url))
+            {
+                return url;
+            }
+            return null;
+        }
+
     }
 }

xivModdingFramework/Helpers/HashGenerator.cs

@@ -138,6 +138,12 @@ public Task RepairIndexDatCounts(XivDataFile dataFile)
             });
         }
 
+        /// <summary>
+        /// This function returns TRUE if the backups should be used, and FALSE if they should not.
+        /// </summary>
+        /// <param name="dataFile"></param>
+        /// <param name="backupsDirectory"></param>
+        /// <returns></returns>
         public Task<bool> CheckForOutdatedBackups(XivDataFile dataFile, DirectoryInfo backupsDirectory)
         {
             return Task.Run(() =>
@@ -149,10 +155,32 @@ public Task<bool> CheckForOutdatedBackups(XivDataFile dataFile, DirectoryInfo ba
 
                 // Since the material addition directly adds to section 1 we can no longer check for outdated using that section header
                 // so instead compare the hashes of sections 2 and 3
-                var backupHashSection2 =  _index.GetIndexSection2Hash(backupDataFile);
-                var currentHashSection2 = _index.GetIndexSection2Hash(currentDataFile);
-                var backupHashSection3 = _index.GetIndexSection3Hash(backupDataFile);
-                var currentHashSection3 = _index.GetIndexSection3Hash(currentDataFile);
+                byte[] currentHashSection2;
+                byte[] currentHashSection3;
+                byte[] backupHashSection2;
+                byte[] backupHashSection3;
+                try
+                {
+                    currentHashSection2 = _index.GetIndexSection2Hash(currentDataFile);
+                    currentHashSection3 = _index.GetIndexSection3Hash(currentDataFile);
+                }
+                catch
+                {
+                    // Base files are fucked, use *any* backups.
+                    return true;
+                }
+
+                try
+                {
+                    backupHashSection2 = _index.GetIndexSection2Hash(backupDataFile);
+                    backupHashSection3 = _index.GetIndexSection3Hash(backupDataFile);
+                }
+                catch
+                {
+                    // Backups are fucked, can't use those.
+                    return false;
+                }
+
 
                 return backupHashSection2.SequenceEqual(currentHashSection2) && backupHashSection3.SequenceEqual(currentHashSection3);
             });
@@ -162,52 +190,39 @@ public Task PerformStartOver(DirectoryInfo backupsDirectory, IProgress<string> p
         {
             return Task.Run(async () =>
             {
-                progress?.Report("Deleting mods...");
-
                 var modding = new Modding(_gameDirectory);
                 var backupsRestored = false;
 
+                // Stop the cache worker since we're blowing up the entire index file and db anyways.
+                // The cache rebuild will start it up again after the cache is rebuilt.
+                XivCache.CacheWorkerEnabled = false;
+
                 try
                 {
-                    // Try to restore the index entries to their original values by deleting any files added by TexTools
-                    // and setting mods to disabled
-                    await modding.DeleteAllFilesAddedByTexTools();
-                    await modding.ToggleAllMods(false);
-                    progress?.Report("Restoring index file backups...");
-                }
-                catch
-                {
-                    // If an exception occurred due to a corrupted modlist which couldn't be deserealized restore the backup index
-                    // files by force
+                    // Try restoring the indexes FIRST.
                     backupsRestored = await RestoreBackups(backupsDirectory);
+                    progress?.Report("Restoring index file backups...");
 
                     if (!backupsRestored)
                     {
                         throw new Exception("Start Over Failed: Index backups missing/outdated.");
                     }
                 }
-                finally
+                catch(Exception ex)
                 {
-                    // If no exception occured, restore the backups anyway just to be safe but don't throw an exception if it fails
-                    // due to outdated or missing backups since setting back the original index values should be enough hopefully
-                    if (!backupsRestored)
+                    try
                     {
-                        backupsRestored = await RestoreBackups(backupsDirectory);
-
-                        // If backups were not restored that means they were missing/outdated so try to make new backups now
-                        if (!backupsRestored)
-                        {
-                            try
-                            {
-                                await BackupIndexFiles(backupsDirectory);
-                            }
-                            catch (Exception ex)
-                            {
-                                throw new Exception("Start Over Failed: Failed to update outdated backups.\n\n" + ex.Message);
-                            }
-                        }
+                        // If the index restore failed, try just disabling.
+                        await modding.DeleteAllFilesAddedByTexTools();
+                        await modding.ToggleAllMods(false);
+                        progress?.Report("Index restore failed, attempting to delete all mods instead...");
+                    } catch
+                    {
+                        throw new Exception("Start Over Failed: Index Backups Invalid and Unable to Disable all mods.");
                     }
-
+                }
+                finally
+                {
                     progress?.Report("Deleting modded dat files...");
 
                     var dat = new Dat(_gameDirectory);
@@ -241,8 +256,7 @@ public Task PerformStartOver(DirectoryInfo backupsDirectory, IProgress<string> p
 
                     await Task.Run(async () =>
                     {
-                        var _cache = new XivCache(_gameDirectory, language);
-                        _cache.RebuildCache();
+                        XivCache.RebuildCache();
                     });
                 }
             });
@@ -302,11 +316,18 @@ public Task<bool> RestoreBackups(DirectoryInfo backupsDirectory)
 
                     if (!File.Exists(backupFile.FullName)) continue;
 
-                    var outdatedCheck = await CheckForOutdatedBackups(xivDataFile, backupsDirectory);
-
-                    if (!outdatedCheck)
+                    try
                     {
-                        outdated = true;
+                        var outdatedCheck = await CheckForOutdatedBackups(xivDataFile, backupsDirectory);
+
+                        if (!outdatedCheck)
+                        {
+                            outdated = true;
+                        }
+                    }
+                    catch { 
+                        // If the outdated check errored out, we likely have completely broken internal dat files.
+                        // ( Either deleted or 0 byte files ), so replacing them with *anything* is an improvement.
                     }
                 }
 

xivModdingFramework/Helpers/IOUtil.cs

@@ -61,7 +61,7 @@ public Task<List<XivCharacter>> GetCharacterList()
                     new XivCharacter
                         {Name = XivStrings.Tail, PrimaryCategory = XivStrings.Character, SecondaryCategory = XivStrings.Tail},
                     new XivCharacter
-                        {Name = XivStrings.Ears, PrimaryCategory = XivStrings.Character, SecondaryCategory = XivStrings.Ears},
+                        {Name = XivStrings.Ear, PrimaryCategory = XivStrings.Character, SecondaryCategory = XivStrings.Ear},
                     new XivCharacter
                     {
                         Name = XivStrings.Face_Paint, PrimaryCategory = XivStrings.Character,
@@ -112,7 +112,7 @@ public async Task<Dictionary<XivRace, int[]>> GetRacesAndNumbersForTextures(XivC
             {
                 folder = XivStrings.TailMtrlFolder;
             }
-            else if (charaItem.SecondaryCategory == XivStrings.Ears)
+            else if (charaItem.SecondaryCategory == XivStrings.Ear)
             {
                 folder = XivStrings.EarsMtrlFolder;
             }
@@ -174,7 +174,7 @@ public async Task<Dictionary<XivRace, int[]>> GetRacesAndNumbersForModels(XivCha
             {
                 folder = XivStrings.TailMDLFolder;
             }
-            else if (charaItem.SecondaryCategory == XivStrings.Ears)
+            else if (charaItem.SecondaryCategory == XivStrings.Ear)
             {
                 folder = XivStrings.EarsMDLFolder;
             }
@@ -234,7 +234,7 @@ public async Task<Dictionary<string, char[]>> GetTypePartForTextures(XivCharacte
                 typeDict = FaceSlotAbbreviationDictionary;
                 file = XivStrings.FaceMtrlFile;
             }
-            else if (charaItem.SecondaryCategory == XivStrings.Ears)
+            else if (charaItem.SecondaryCategory == XivStrings.Ear)
             {
                 folder = string.Format(XivStrings.EarsMtrlFolder, race.GetRaceCode(),
                     num.ToString().PadLeft(4, '0'));
@@ -296,7 +296,7 @@ public async Task<char[]> GetPartForTextures(XivCharacter charaItem, XivRace rac
                 folder = string.Format(XivStrings.TailMtrlFolder, race.GetRaceCode(), num.ToString().PadLeft(4, '0'));
                 file = XivStrings.TailMtrlFile;
             }
-            else if (charaItem.SecondaryCategory == XivStrings.Ears)
+            else if (charaItem.SecondaryCategory == XivStrings.Ear)
             {
                 folder = string.Format(XivStrings.EarsMtrlFolder, race.GetRaceCode(), num.ToString().PadLeft(4, '0'));
 
@@ -387,7 +387,7 @@ public async Task<List<string>> GetTypeForModels(XivCharacter charaItem, XivRace
                 typeDict = TailSlotAbbreviationDictionary;
                 file = XivStrings.TailMDLFile;
             }
-            else if (charaItem.SecondaryCategory == XivStrings.Ears)
+            else if (charaItem.SecondaryCategory == XivStrings.Ear)
             {
                 folder = string.Format(XivStrings.EarsMDLFolder, race.GetRaceCode(),
                     num.ToString().PadLeft(4, '0'));
@@ -526,7 +526,7 @@ await Task.Run(() => Parallel.For(0, 300, (i) =>
         /// </summary>
         private static readonly Dictionary<string, string> EarsSlotAbbreviationDictionary = new Dictionary<string, string>
         {
-            {XivStrings.Ears, "zer"},
+            {XivStrings.Ear, "zer"},
             {XivStrings.InnerEar, "fac_"},
             {XivStrings.OuterEar, "" }
         };