Added support for updating manifest.json total_package_size (if it exists), slightly improved error messages, added comments

Author: HughesMDflyer4

MSFS Layout Generator/MSFS Layout Generator.csproj

@@ -105,6 +105,7 @@
   <ItemGroup>
     <Compile Include="Content.cs" />
     <Compile Include="Layout.cs" />
+    <Compile Include="Manifest.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Utilities.cs" />

MSFS Layout Generator/Manifest.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.Json.Serialization;
+using System.Threading.Tasks;
+
+namespace MSFSLayoutGenerator
+{
+    public class Manifest
+    {
+        [JsonExtensionDataAttribute]
+        public IDictionary<string, object> Data { get; set; }
+
+        [JsonPropertyName("total_package_size")]
+        public string TotalPackageSize { get; set; }
+    }
+}

MSFS Layout Generator/Program.cs

@@ -15,20 +15,30 @@ static void Main(string[] layoutPaths)
         {
             if(layoutPaths.Count() == 0)
             {
-                Utilities.Log(new  string[] { "No layout.json paths specified.", "Usage: MSFSLayoutGenerator.exe <layout.json> ..." });
+                Utilities.Log(new string[] { "No layout.json paths specified.", "Usage: MSFSLayoutGenerator.exe <layout.json> ..." });
             }
             else
             {
+                //Some serialization options to match layout.json as closely as possible to the MSFS format.
+                JsonSerializerOptions jsonOptions = new JsonSerializerOptions();
+                jsonOptions.WriteIndented = true;
+                jsonOptions.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(UnicodeRanges.All);
+
                 foreach (string path in layoutPaths)
                 {
                     Layout layout = new Layout();
+
+                    //Get absolute path in case we have a relative path.
                     string layoutPath = Path.GetFullPath(path);
                     string json;
+                    long totalPackageSize = 0;
 
+                    //Ensure that the specified file is named "layout.json".
                     if (string.Equals(Path.GetFileName(layoutPath), "layout.json", StringComparison.OrdinalIgnoreCase))
                     {
                         foreach (string file in Directory.GetFiles(Path.GetDirectoryName(layoutPath), "*.*", SearchOption.AllDirectories))
                         {
+                            //Certain .NET APIs don't like long file paths, so we check to ensure the length is under the limit.
                             if (file.Length > 259)
                             {
                                 Utilities.Log("One or more file paths in the folder containing \"" + layoutPath + "\" are 260 characters or greater in length. Please move this package to a directory with a shorter path.");
@@ -40,10 +50,20 @@ static void Main(string[] layoutPaths)
                             content.Path = relativePath;
                             content.Size = new FileInfo(file).Length;
                             content.Date = new FileInfo(file).LastWriteTimeUtc.ToFileTimeUtc();
-
+                            
+                            //The MSFS virtual file system doesn't need a few select files/folders to be specified in layout.json, so we omit those.
                             if (!relativePath.StartsWith("_CVT_", StringComparison.OrdinalIgnoreCase) && !string.Equals(relativePath, "business.json") && !string.Equals(relativePath, "layout.json") && !string.Equals(relativePath, "manifest.json"))
                             {
                                 layout.Content.Add(content);
+
+                                //Log the size of each file so we can update total_package_size in manifest.json later if it exists.
+                                totalPackageSize += content.Size;
+                            }
+
+                            //The size of these files must be considered for total_package_size as well
+                            if(string.Equals(relativePath, "business.json") || string.Equals(relativePath, "manifest.json"))
+                            {
+                                totalPackageSize += content.Size;
                             }
                         }
 
@@ -52,19 +72,54 @@ static void Main(string[] layoutPaths)
                             Utilities.Log("No files were found in the folder containing \"" + layoutPath + "\". The layout.json will not be updated.");
                         }
 
-                        JsonSerializerOptions jsonOptions = new JsonSerializerOptions();
-                        jsonOptions.WriteIndented = true;
-                        jsonOptions.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(UnicodeRanges.All);
-
                         json = JsonSerializer.Serialize(layout, jsonOptions);
 
                         try
                         {
+                            //Changing new lines to match MSFS format (LF).
                             File.WriteAllText(layoutPath, json.Replace("\r\n", "\n"));
                         }
                         catch (Exception ex)
                         {
-                            Utilities.Log("Error: " + ex.Message);
+                            Utilities.Log("Failed to write layout.json: " + ex.Message);
+                        }
+
+                        //Add layout.json size now that it has been written.
+                        totalPackageSize += new FileInfo(layoutPath).Length;
+
+                        //Getting the full path to manifest.json so we can update it.
+                        string manifestPath = Path.Combine(new string[] { Path.GetDirectoryName(layoutPath), "manifest.json" });
+
+                        if (File.Exists(manifestPath))
+                        {
+                            Dictionary<string, object> manifest = new Dictionary<string, object>();
+
+                            try
+                            {
+                                manifest = JsonSerializer.Deserialize<Dictionary<string, object>>(File.ReadAllText(manifestPath));
+                            }
+                            catch (Exception ex)
+                            {
+                                Utilities.Log("Failed to parse manifest.json: " + ex.Message);
+                            }
+
+                            //If manifest.json exists and contains the total_package_size property, we update it with the size we collected by iterating through each file for layout.json.
+                            if (manifest.ContainsKey("total_package_size"))
+                            {
+                                manifest["total_package_size"] = totalPackageSize.ToString().PadLeft(20, '0');
+
+                                string manifestJson = JsonSerializer.Serialize(manifest, jsonOptions);
+
+                                try
+                                {
+                                    //Strangly, line endings are different on manifest.json (CRLF)
+                                    File.WriteAllText(manifestPath, manifestJson);
+                                }
+                                catch (Exception ex)
+                                {
+                                    Utilities.Log("Failed to write manifest.json: " + ex.Message);
+                                }
+                            }
                         }
                     }
                     else

MSFS Layout Generator/Properties/AssemblyInfo.cs

@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.3.0")]
-[assembly: AssemblyFileVersion("1.0.3.0")]
+[assembly: AssemblyVersion("1.1.0.0")]
+[assembly: AssemblyFileVersion("1.1.0.0")]