Changes to TTMP format to include new fields

- Url & MinimumFrameworkVersion at the modpack level
- IsDefault at the mod level

Author: Lunaretic

xivModdingFramework/Helpers/Constants.cs

@@ -3,6 +3,7 @@
 using System;
 using System.Collections.Generic;
 using System.Text;
+using System.Text.RegularExpressions;
 
 namespace xivModdingFramework.Helpers
 {
@@ -14,5 +15,11 @@ public static class Constants
         /// </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/Helpers/IOUtil.cs

@@ -252,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/Mods/DataContainers/ModList.cs

@@ -14,7 +14,11 @@
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+using System;
 using System.Collections.Generic;
+using System.Diagnostics.Contracts;
+using System.Security.Cryptography;
+using System.Text;
 
 namespace xivModdingFramework.Mods.DataContainers
 {
@@ -91,6 +95,11 @@ public class Mod
         /// </remarks>
         public bool enabled { get; set; }
 
+        /// <summary>
+        /// The minimum framework version necessary to operate on this mod safely.
+        /// </summary>
+        public string minimumFrameworkVersion = "1.0.0.0";
+
         /// <summary>
         /// The modPack associated with this mod
         /// </summary>
@@ -132,10 +141,30 @@ public class Data
         /// When importing a previously modified texture, this value is used to determine whether the modified data will be overwritten
         /// </remarks>
         public int modSize { get; set; }
+
     }
 
     public class ModPack
     {
+
+        /// <summary>
+        /// Generates a hash identifier from this mod's name and author information,
+        /// in lowercase.  For identifying new versions of same mods, potentially.
+        /// </summary>
+        /// <returns></returns>
+        public byte[] GetHash()
+        {
+            using (SHA256 sha = SHA256.Create())
+            {
+                var n = name.ToLower();
+                var a = author.ToLower();
+                var key = n + a;
+                var keyBytes= Encoding.Unicode.GetBytes(key);
+                var hash = sha.ComputeHash(keyBytes);
+                return hash;
+            }
+        }
+
         /// <summary>
         /// The name of the modpack
         /// </summary>
@@ -150,5 +179,10 @@ public class ModPack
         /// The modpack version
         /// </summary>
         public string version { get; set; }
+
+        /// <summary>
+        /// The URL the author associated with this modpack.
+        /// </summary>
+        public string url { get; set; }
     }
 }

xivModdingFramework/Mods/DataContainers/ModOption.cs

@@ -79,6 +79,14 @@ public class ModData
         /// </summary>
         public string FullPath { get; set; }
 
+        /// <summary>
+        /// Whether or not this item is a default SE file.
+        /// These files are still included in full, for the sake
+        /// of backwards compatability, but in the future may have
+        /// handling to simply disable existing mods, rather than copy over.
+        /// </summary>
+        public bool IsDefault = false;
+
         /// <summary>
         /// The raw mod data
         /// </summary>

xivModdingFramework/Mods/DataContainers/ModPackData.cs

@@ -41,6 +41,11 @@ public class ModPackData
         /// </summary>
         public string Description { get; set; }
 
+        /// <summary>
+        /// Author's supplied URL for the modpack.
+        /// </summary>
+        public string Url { get; set; }
+
         /// <summary>
         /// A list of pages containing a list of mod groups for that particular page
         /// </summary>

xivModdingFramework/Mods/DataContainers/ModPackJson.cs

@@ -15,6 +15,8 @@
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 using System.Collections.Generic;
+using System.Security.Cryptography;
+using System.Text;
 
 namespace xivModdingFramework.Mods.DataContainers
 {
@@ -45,6 +47,36 @@ public class ModPackJson
         /// </summary>
         public string Description { get; set; }
 
+        /// <summary>
+        /// The modpack's weblink.
+        /// </summary>
+        public string Url { get; set; }
+
+        /// <summary>
+        /// Minimum required version of the Framework to import this modpack file.
+        /// The 1.0.0.0 here is purely a fallback default; it should be assigned to
+        /// in the actual modpack generation.
+        /// </summary>
+        public string MinimumFrameworkVersion = "1.0.0.0";
+
+        /// <summary>
+        /// Generates a hash identifier from this mod's name and author information,
+        /// in lowercase.  For identifying new versions of same mods, potentially.
+        /// </summary>
+        /// <returns></returns>
+        public byte[] GetHash()
+        {
+            using (SHA256 sha = SHA256.Create())
+            {
+                var n = Name.ToLower();
+                var a = Author.ToLower();
+                var key = n + a;
+                var keyBytes = Encoding.Unicode.GetBytes(key);
+                var hash = sha.ComputeHash(keyBytes);
+                return hash;
+            }
+        }
+
         /// <summary>
         /// A list of pages containing a list of mod groups for that particular page
         /// </summary>
@@ -160,6 +192,16 @@ public class ModsJson
         /// </summary>
         public string DatFile { get; set; }
 
+        /// <summary>
+        /// Indicates if this "Mod" is actually just a placeholder in a modpack, 
+        /// indicating that we want any existing mod on this file to be disabled.
+        /// 
+        /// Default mod entries include completely valid copies of their original
+        /// SE item, for backwards compatability and in case some code imports
+        /// them incorrectly or needs the information for calculations.
+        /// </summary>
+        public bool IsDefault { get; set; }
+
         /// <summary>
         /// The Mod Pack Entry
         /// </summary>

xivModdingFramework/Mods/DataContainers/SimpleModPackData.cs

@@ -36,6 +36,11 @@ public class SimpleModPackData
         /// </summary>
         public Version Version { get; set; }
 
+        /// <summary>
+        /// The modpack Url
+        /// </summary>
+        public string Url = "";
+
         /// <summary>
         /// The description for the mod pack
         /// </summary>
@@ -70,6 +75,11 @@ public class SimpleModData
         /// </summary>
         public long ModOffset { get; set; }
 
+        /// <summary>
+        /// If the entry is SE Default data or not.
+        /// </summary>
+        public bool IsDefault = false;
+
         /// <summary>
         /// The size of the mod data
         /// </summary>

xivModdingFramework/Mods/FileTypes/TTMP.cs

@@ -34,6 +34,8 @@ public class TTMP
     {
         private readonly string _currentWizardTTMPVersion = "1.0w";
         private readonly string _currentSimpleTTMPVersion = "1.0s";
+        private const string _minimumAssembly = "1.0.0.0";
+
         private string _tempMPD, _tempMPL, _source;
         private readonly DirectoryInfo _modPackDirectory;
 
@@ -61,10 +63,12 @@ public async Task<int> CreateWizardModPack(ModPackData modPackData, IProgress<do
                 var modPackJson = new ModPackJson
                 {
                     TTMPVersion = _currentWizardTTMPVersion,
+                    MinimumFrameworkVersion = _minimumAssembly,
                     Name = modPackData.Name,
                     Author = modPackData.Author,
                     Version = modPackData.Version.ToString(),
                     Description = modPackData.Description,
+                    Url = modPackData.Url,
                     ModPackPages = new List<ModPackPageJson>()
                 };
 
@@ -123,6 +127,7 @@ public async Task<int> CreateWizardModPack(ModPackData modPackData, IProgress<do
                                         Name = modOptionMod.Value.Name,
                                         Category = modOptionMod.Value.Category.GetEnDisplayName(),
                                         FullPath = modOptionMod.Key,
+                                        IsDefault = modOptionMod.Value.IsDefault,
                                         ModSize = modOptionMod.Value.ModDataBytes.Length,
                                         ModOffset = binaryWriter.BaseStream.Position,
                                         DatFile = dataFile.GetDataFileName(),
@@ -201,6 +206,8 @@ public async Task<int> CreateSimpleModPack(SimpleModPackData modPackData, Direct
                     Name = modPackData.Name,
                     Author = modPackData.Author,
                     Version = modPackData.Version.ToString(),
+                    MinimumFrameworkVersion = _minimumAssembly,
+                    Url = modPackData.Url,
                     Description = modPackData.Description,
                     SimpleModsList = new List<ModsJson>()
                 };
@@ -218,6 +225,7 @@ public async Task<int> CreateSimpleModPack(SimpleModPackData modPackData, Direct
                                 FullPath = simpleModData.FullPath,
                                 ModSize = simpleModData.ModSize,
                                 DatFile = simpleModData.DatFile,
+                                IsDefault = simpleModData.IsDefault,
                                 ModOffset = binaryWriter.BaseStream.Position,
                                 ModPackEntry = new ModPack
                                 {