adjust parsed log fields to support external tools

Author: Pathoschild

docs/release-notes.md

@@ -10,6 +10,7 @@
     * Fixed some JSON files breaking page layout.
   * Improved log parser:
     * Mods which failed to load are now shown in the mod list (with 'failed to load' in the error column).
+    * Added suggested fix if there's a newer SMAPI version available.
     * Reduced response times with a new analysis cache and client-side fetch.
     * Removed support for very old SMAPI logs.
     * You can now download a JSON representation of the parsed log (see the download link at the bottom of the log page).

src/SMAPI.Web/Framework/LogParsing/LogParser.cs

@@ -130,6 +130,8 @@ public ParsedLog Parse(string? logText)
                     inContentPackList = inContentPackList && message.Level == LogLevel.Info && this.ContentPackListEntryPattern.IsMatch(message.Text);
                     inSkippedModsList = inSkippedModsList && message.Level == LogLevel.Error && this.SkippedModListEntryPattern.IsMatch(message.Text);
                     inModUpdateList = inModUpdateList && message.Level == LogLevel.Alert && this.ModUpdateListEntryPattern.IsMatch(message.Text);
+                    bool hasModUpdates = false;
+                    bool hasApiUpdate = false;
 
                     // mod list
                     if (!inModList && message.Level == LogLevel.Info && this.ModListStartPattern.IsMatch(message.Text))
@@ -150,6 +152,8 @@ public ParsedLog Parse(string? logText)
                             mods[name] = entries = [];
                         entries.Add(new LogModInfo(ModType.CodeMod, name: name, author: author, version: version, description: description, loaded: true));
 
+                        log.TotalCodeMods++;
+
                         message.Section = LogSection.ModsList;
                     }
 
@@ -173,6 +177,8 @@ public ParsedLog Parse(string? logText)
                             mods[name] = entries = [];
                         entries.Add(new LogModInfo(ModType.ContentPack, name: name, author: author, version: version, description: description, contentPackFor: forMod, loaded: true));
 
+                        log.TotalContentPacks++;
+
                         message.Section = LogSection.ContentPackList;
                     }
 
@@ -215,6 +221,7 @@ public ParsedLog Parse(string? logText)
                         foreach (LogModInfo entry in entries)
                             entry.SetUpdate(newVersion, link);
 
+                        hasModUpdates = true;
                         message.Section = LogSection.ModUpdateList;
                     }
                     else if (message.Level == LogLevel.Alert && this.SmapiUpdatePattern.IsMatch(message.Text))
@@ -224,6 +231,8 @@ public ParsedLog Parse(string? logText)
                         string link = match.Groups["link"].Value;
 
                         smapiMod.SetUpdate(version, link);
+
+                        hasApiUpdate = true;
                     }
 
                     // platform info line
@@ -235,7 +244,6 @@ public ParsedLog Parse(string? logText)
                         log.OperatingSystem = match.Groups["os"].Value;
 
                         smapiMod.OverrideVersion(log.ApiVersion);
-                        log.ApiVersionParsed = smapiMod.GetParsedVersion();
                     }
 
                     // mod path line

src/SMAPI.Web/Framework/LogParsing/Models/ParsedLog.cs

@@ -31,9 +31,6 @@ public class ParsedLog
     /// <summary>The SMAPI version.</summary>
     public string? ApiVersion { get; set; }
 
-    /// <summary>The parsed SMAPI version, if it's valid.</summary>
-    public ISemanticVersion? ApiVersionParsed { get; set; }
-
     /// <summary>The game version.</summary>
     public string? GameVersion { get; set; }
 
@@ -55,6 +52,18 @@ public class ParsedLog
     /// <summary>The log messages.</summary>
     public LogMessage[] Messages { get; set; } = [];
 
+    /// <summary>The number of loaded non-content-pack mods.</summary>
+    public int TotalCodeMods { get; set; }
+
+    /// <summary>The number of loaded content packs.</summary>
+    public int TotalContentPacks { get; set; }
+
+    /// <summary>Whether update alerts were detected for SMAPI itself.</summary>
+    public bool HasApiUpdate { get; set; }
+
+    /// <summary>Whether update alerts were detected for one or more installed mods.</summary>
+    public bool HasModUpdates { get; set; }
+
 
     /*********
     ** Public methods
@@ -74,13 +83,16 @@ public ParsedLog(ParsedLog log)
 
         // log data
         this.ApiVersion = log.ApiVersion;
-        this.ApiVersionParsed = log.ApiVersionParsed;
         this.GameVersion = log.GameVersion;
         this.OperatingSystem = log.OperatingSystem;
         this.GamePath = log.GamePath;
         this.ModPath = log.ModPath;
         this.Timestamp = log.Timestamp;
         this.Mods = log.Mods;
         this.Messages = log.Messages;
+        this.TotalCodeMods = log.TotalCodeMods;
+        this.TotalContentPacks = log.TotalContentPacks;
+        this.HasApiUpdate = log.HasApiUpdate;
+        this.HasModUpdates = log.HasModUpdates;
     }
 }

src/SMAPI.Web/Views/LogParser/Index.cshtml

@@ -232,10 +232,14 @@
     @* parsed log *@
     <div v-if="data.IsValid">
         @* suggested fixes *@
-        <div v-if="hasOutdatedMods">
+        <div v-if="data.HasApiUpdate || hasOutdatedMods">
             <h2>Suggested fixes</h2>
             <ul id="fix-list">
-                <li>
+                <li v-if="data.HasApiUpdate">
+                    You have an older version of SMAPI installed. Consider updating SMAPI to fix problems.
+                </li>
+
+                <li v-if="hasOutdatedMods">
                     Consider updating these mods to fix problems:
 
                     <table id="updates" class="table">