Copy updater messages to an update.log file in the working directory.

This commit is contained in:
Paul Chote
2018-05-08 18:30:16 +01:00
committed by abcdefg30
parent e83f5a9d59
commit be6fd1c7c7

View File

@@ -11,6 +11,7 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO;
using System.Linq; using System.Linq;
using OpenRA.FileSystem; using OpenRA.FileSystem;
using OpenRA.Mods.Common.UpdateRules; using OpenRA.Mods.Common.UpdateRules;
@@ -112,40 +113,61 @@ namespace OpenRA.Mods.Common.UtilityCommands
Console.WriteLine("Run this command with the --apply flag to apply the update rules."); Console.WriteLine("Run this command with the --apply flag to apply the update rules.");
} }
static void Log(StreamWriter logWriter, string format, params object[] args)
{
logWriter.Write(format, args);
Console.Write(format, args);
}
static void LogLine(StreamWriter logWriter, string format, params object[] args)
{
logWriter.WriteLine(format, args);
Console.WriteLine(format, args);
}
static void LogLine(StreamWriter logWriter)
{
logWriter.WriteLine();
Console.WriteLine();
}
static void ApplyRules(ModData modData, IEnumerable<UpdateRule> rules, bool skipMaps) static void ApplyRules(ModData modData, IEnumerable<UpdateRule> rules, bool skipMaps)
{ {
Console.WriteLine(); Console.WriteLine();
var logWriter = File.CreateText("update.log");
logWriter.AutoFlush = true;
var externalFilenames = new HashSet<string>(); var externalFilenames = new HashSet<string>();
foreach (var rule in rules) foreach (var rule in rules)
{ {
var manualSteps = new List<string>(); var manualSteps = new List<string>();
var allFiles = new YamlFileSet(); var allFiles = new YamlFileSet();
Console.WriteLine("{0}: {1}", rule.GetType().Name, rule.Name); LogLine(logWriter, "{0}: {1}", rule.GetType().Name, rule.Name);
try try
{ {
Console.Write(" Updating mod... "); Log(logWriter, " Updating mod... ");
manualSteps.AddRange(UpdateUtils.UpdateMod(modData, rule, out allFiles, externalFilenames)); manualSteps.AddRange(UpdateUtils.UpdateMod(modData, rule, out allFiles, externalFilenames));
Console.WriteLine("COMPLETE"); LogLine(logWriter, "COMPLETE");
} }
catch (Exception ex) catch (Exception ex)
{ {
Console.WriteLine("FAILED"); Console.WriteLine("FAILED");
Console.WriteLine(); LogLine(logWriter);
Console.WriteLine(" The automated changes for this rule were not applied because of an error."); LogLine(logWriter, " The automated changes for this rule were not applied because of an error.");
Console.WriteLine(" After the issue reported below is resolved you should run the updater"); LogLine(logWriter, " After the issue reported below is resolved you should run the updater");
Console.WriteLine(" with SOURCE set to {0} to retry these changes", rule.GetType().Name); LogLine(logWriter, " with SOURCE set to {0} to retry these changes", rule.GetType().Name);
Console.WriteLine(); LogLine(logWriter);
Console.WriteLine(" The exception reported was:"); LogLine(logWriter, " The exception reported was:");
Console.WriteLine(" " + ex.ToString().Replace("\n", "\n ")); LogLine(logWriter, " " + ex.ToString().Replace("\n", "\n "));
continue; continue;
} }
Console.Write(" Updating system maps... "); Log(logWriter, " Updating system maps... ");
if (!skipMaps) if (!skipMaps)
{ {
@@ -164,18 +186,17 @@ namespace OpenRA.Mods.Common.UtilityCommands
} }
catch (Exception ex) catch (Exception ex)
{ {
Console.WriteLine("FAILED"); LogLine(logWriter, "FAILED");
LogLine(logWriter);
Console.WriteLine(); LogLine(logWriter, " The automated changes for this rule were not applied because of an error.");
Console.WriteLine(" The automated changes for this rule were not applied because of an error."); LogLine(logWriter, " After the issue reported below is resolved you should run the updater");
Console.WriteLine(" After the issue reported below is resolved you should run the updater"); LogLine(logWriter, " with SOURCE set to {0} to retry these changes", rule.GetType().Name);
Console.WriteLine(" with SOURCE set to {0} to retry these changes", rule.GetType().Name); LogLine(logWriter);
Console.WriteLine(); LogLine(logWriter, " The map that caused the error was:");
Console.WriteLine(" The map that caused the error was:"); LogLine(logWriter, " " + package.Name);
Console.WriteLine(" " + package.Name); LogLine(logWriter);
Console.WriteLine(); LogLine(logWriter, " The exception reported was:");
Console.WriteLine(" The exception reported was:"); LogLine(logWriter, " " + ex.ToString().Replace("\n", "\n "));
Console.WriteLine(" " + ex.ToString().Replace("\n", "\n "));
mapsFailed = true; mapsFailed = true;
break; break;
} }
@@ -184,33 +205,34 @@ namespace OpenRA.Mods.Common.UtilityCommands
if (mapsFailed) if (mapsFailed)
continue; continue;
Console.WriteLine("COMPLETE"); LogLine(logWriter, "COMPLETE");
} }
else else
Console.WriteLine("SKIPPED"); LogLine(logWriter, "SKIPPED");
// Files are saved after each successful automated rule update // Files are saved after each successful automated rule update
allFiles.Save(); allFiles.Save();
if (manualSteps.Any()) if (manualSteps.Any())
{ {
Console.WriteLine(" Manual changes are required to complete this update:"); LogLine(logWriter, " Manual changes are required to complete this update:");
Console.WriteLine(UpdateUtils.FormatMessageList(manualSteps, 1)); LogLine(logWriter, UpdateUtils.FormatMessageList(manualSteps, 1));
} }
Console.WriteLine(); LogLine(logWriter);
} }
if (externalFilenames.Any()) if (externalFilenames.Any())
{ {
Console.WriteLine("The following external mod files have been ignored:"); LogLine(logWriter, "The following external mod files have been ignored:");
Console.WriteLine(UpdateUtils.FormatMessageList(externalFilenames)); LogLine(logWriter, UpdateUtils.FormatMessageList(externalFilenames));
Console.WriteLine("These files should be updated by running --update-mod on the referenced mod(s)"); LogLine(logWriter, "These files should be updated by running --update-mod on the referenced mod(s)");
Console.WriteLine(); LogLine(logWriter);
} }
Console.WriteLine("Semi-automated update complete."); Console.WriteLine("Semi-automated update complete.");
Console.WriteLine("Please review the messages above for any manual actions that must be applied."); Console.WriteLine("Please review the messages above for any manual actions that must be applied.");
Console.WriteLine("These messages have also been written to an update.log file in the current directory.");
} }
} }
} }