Merge pull request #10797 from pchote/fix-upgrade-rules

Fix mod updater and clear out legacy rules.

OpenRA.Mods.Common/UtilityCommands/UpgradeMapCommand.cs

@@ -9,6 +9,7 @@
  */
 #endregion
 
+using System;
 using OpenRA.FileSystem;
 
 namespace OpenRA.Mods.Common.UtilityCommands
@@ -28,11 +29,18 @@ namespace OpenRA.Mods.Common.UtilityCommands
 			// HACK: The engine code assumes that Game.modData is set.
 			Game.ModData = modData;
 
+			var engineDate = Exts.ParseIntegerInvariant(args[2]);
+			if (engineDate < UpgradeRules.MinimumSupportedVersion)
+			{
+				Console.WriteLine("Unsupported engine version. Use the release-{0} utility to update to that version, and then try again",
+					UpgradeRules.MinimumSupportedVersion);
+				return;
+			}
+
 			var package = modData.ModFiles.OpenWritablePackage(args[1]);
 			UpgradeRules.UpgradeMapFormat(modData, package);
 
 			var map = new Map(modData, package);
-			var engineDate = Exts.ParseIntegerInvariant(args[2]);
 			UpgradeRules.UpgradeWeaponRules(engineDate, ref map.WeaponDefinitions, null, 0);
 			UpgradeRules.UpgradeActorRules(engineDate, ref map.RuleDefinitions, null, 0);
 			UpgradeRules.UpgradePlayers(engineDate, ref map.PlayerDefinitions, null, 0);

OpenRA.Mods.Common/UtilityCommands/UpgradeModCommand.cs

@@ -10,6 +10,7 @@
 #endregion
 
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using OpenRA.FileSystem;
@@ -25,6 +26,32 @@ namespace OpenRA.Mods.Common.UtilityCommands
 			return args.Length >= 2;
 		}
 
+		delegate void UpgradeAction(int engineVersion, ref List<MiniYamlNode> nodes, MiniYamlNode parent, int depth);
+
+		void ProcessYaml(string type, IEnumerable<string> files, ModData modData, int engineDate, UpgradeAction processFile)
+		{
+			Console.WriteLine("Processing {0}:", type);
+			foreach (var filename in files)
+			{
+				Console.WriteLine("\t" + filename);
+				string name;
+				IReadOnlyPackage package;
+				if (!modData.ModFiles.TryGetPackageContaining(filename, out package, out name) || !(package is Folder))
+				{
+					Console.WriteLine("\t\tFile cannot be opened for writing! Ignoring...");
+					continue;
+				}
+
+				var yaml = MiniYaml.FromStream(package.GetStream(name));
+				processFile(engineDate, ref yaml, null, 0);
+
+				// Generate the on-disk path
+				var path = Path.Combine(package.Name, name);
+				using (var file = new StreamWriter(path))
+					file.Write(yaml.WriteToString());
+			}
+		}
+
 		[Desc("CURRENTENGINE", "Upgrade mod rules to the latest engine version.")]
 		public void Run(ModData modData, string[] args)
 		{
@@ -33,72 +60,19 @@ namespace OpenRA.Mods.Common.UtilityCommands
 			modData.MapCache.LoadMaps();
 
 			var engineDate = Exts.ParseIntegerInvariant(args[1]);
-
+			if (engineDate < UpgradeRules.MinimumSupportedVersion)
-			Console.WriteLine("Processing Rules:");
-			foreach (var filename in modData.Manifest.Rules)
 			{
-				Console.WriteLine("\t" + filename);
+				Console.WriteLine("Unsupported engine version. Use the release-{0} utility to update to that version, and then try again",
-				var yaml = MiniYaml.FromFile(filename);
+					UpgradeRules.MinimumSupportedVersion);
-				UpgradeRules.UpgradeActorRules(engineDate, ref yaml, null, 0);
+				return;
-
-				using (var file = new StreamWriter(filename))
-					file.Write(yaml.WriteToString());
 			}
 
-			Console.WriteLine("Processing Weapons:");
+			ProcessYaml("Rules", modData.Manifest.Rules, modData, engineDate, UpgradeRules.UpgradeActorRules);
-			foreach (var filename in modData.Manifest.Weapons)
+			ProcessYaml("Weapons", modData.Manifest.Weapons, modData, engineDate, UpgradeRules.UpgradeWeaponRules);
-			{
+			ProcessYaml("Tilesets", modData.Manifest.TileSets, modData, engineDate, UpgradeRules.UpgradeTileset);
-				Console.WriteLine("\t" + filename);
+			ProcessYaml("Cursors", modData.Manifest.Cursors, modData, engineDate, UpgradeRules.UpgradeCursors);
-				var yaml = MiniYaml.FromFile(filename);
+			ProcessYaml("Chrome Metrics", modData.Manifest.ChromeMetrics, modData, engineDate, UpgradeRules.UpgradeChromeMetrics);
-				UpgradeRules.UpgradeWeaponRules(engineDate, ref yaml, null, 0);
+			ProcessYaml("Chrome Layout", modData.Manifest.ChromeLayout, modData, engineDate, UpgradeRules.UpgradeChromeLayout);
-
-				using (var file = new StreamWriter(filename))
-					file.Write(yaml.WriteToString());
-			}
-
-			Console.WriteLine("Processing Tilesets:");
-			foreach (var filename in modData.Manifest.TileSets)
-			{
-				Console.WriteLine("\t" + filename);
-				var yaml = MiniYaml.FromFile(filename);
-				UpgradeRules.UpgradeTileset(engineDate, ref yaml, null, 0);
-
-				using (var file = new StreamWriter(filename))
-					file.Write(yaml.WriteToString());
-			}
-
-			Console.WriteLine("Processing Cursors:");
-			foreach (var filename in modData.Manifest.Cursors)
-			{
-				Console.WriteLine("\t" + filename);
-				var yaml = MiniYaml.FromFile(filename);
-				UpgradeRules.UpgradeCursors(engineDate, ref yaml, null, 0);
-
-				using (var file = new StreamWriter(filename))
-					file.Write(yaml.WriteToString());
-			}
-
-			Console.WriteLine("Processing Chrome Metrics:");
-			foreach (var filename in modData.Manifest.ChromeMetrics)
-			{
-				Console.WriteLine("\t" + filename);
-				var yaml = MiniYaml.FromFile(filename);
-				UpgradeRules.UpgradeChromeMetrics(engineDate, ref yaml, null, 0);
-
-				using (var file = new StreamWriter(filename))
-					file.Write(yaml.WriteToString());
-			}
-
-			Console.WriteLine("Processing Chrome Layout:");
-			foreach (var filename in modData.Manifest.ChromeLayout)
-			{
-				Console.WriteLine("\t" + filename);
-				var yaml = MiniYaml.FromFile(filename);
-				UpgradeRules.UpgradeChromeLayout(engineDate, ref yaml, null, 0);
-
-				using (var file = new StreamWriter(filename))
-					file.Write(yaml.WriteToString());
-			}
 
 			Console.WriteLine("Processing Maps:");
 			var mapPreviews = modData.MapCache