using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;
using StardewModdingAPI.Toolkit;
using StardewModdingAPI.Web.Framework.LogParsing.Models;
namespace StardewModdingAPI.Web.Framework.LogParsing
{
/// Parses SMAPI log files.
public class LogParser
{
/*********
** Fields
*********/
/// A regex pattern matching the start of a SMAPI message.
private readonly Regex MessageHeaderPattern = new Regex(@"^\[(?\d\d:\d\d:\d\d) (?[a-z]+) +(?[^\]]+)\] ", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching SMAPI's initial platform info message.
private readonly Regex InfoLinePattern = new Regex(@"^SMAPI (?.+) with Stardew Valley (?.+) on (?.+)", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching SMAPI's mod folder path line.
private readonly Regex ModPathPattern = new Regex(@"^Mods go here: (?.+)", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching SMAPI's log timestamp line.
private readonly Regex LogStartedAtPattern = new Regex(@"^Log started at (?.+) UTC", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching the start of SMAPI's mod list.
private readonly Regex ModListStartPattern = new Regex(@"^Loaded \d+ mods:$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching an entry in SMAPI's mod list.
/// The author name and description are optional.
private readonly Regex ModListEntryPattern = new Regex(@"^ (?.+?) (?" + SemanticVersion.UnboundedVersionPattern + @")(?: by (?[^\|]+))?(?: \| (?.+))?$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching the start of SMAPI's content pack list.
private readonly Regex ContentPackListStartPattern = new Regex(@"^Loaded \d+ content packs:$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching an entry in SMAPI's content pack list.
private readonly Regex ContentPackListEntryPattern = new Regex(@"^ (?.+) (?.+) by (?.+) \| for (?.+?)(?: \| (?.+))?$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching the start of SMAPI's mod update list.
private readonly Regex ModUpdateListStartPattern = new Regex(@"^You can update \d+ mods?:$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching an entry in SMAPI's mod update list.
private readonly Regex ModUpdateListEntryPattern = new Regex(@"^ (?.+?) (?" + SemanticVersion.UnboundedVersionPattern + @"): (? .+)$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/// A regex pattern matching SMAPI's update line.
private readonly Regex SMAPIUpdatePattern = new Regex(@"^You can update SMAPI to (?" + SemanticVersion.UnboundedVersionPattern + @"): (? .+)$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
/*********
** Public methods
*********/
/// Parse SMAPI log text.
/// The SMAPI log text.
public ParsedLog Parse(string logText)
{
try
{
// skip if empty
if (string.IsNullOrWhiteSpace(logText))
{
return new ParsedLog
{
IsValid = false,
RawText = logText,
Error = "The log is empty."
};
}
// init log
ParsedLog log = new ParsedLog
{
IsValid = true,
RawText = logText,
Messages = this.CollapseRepeats(this.GetMessages(logText)).ToArray()
};
// parse log messages
LogModInfo smapiMod = new LogModInfo { Name = "SMAPI", Author = "Pathoschild", Description = "", Loaded = true};
LogModInfo gameMod = new LogModInfo { Name = "game", Author = "", Description = "", Loaded = true };
IDictionary mods = new Dictionary();
bool inModList = false;
bool inContentPackList = false;
bool inModUpdateList = false;
foreach (LogMessage message in log.Messages)
{
// collect stats
if (message.Level == LogLevel.Error)
{
switch (message.Mod)
{
case "SMAPI":
smapiMod.Errors++;
break;
case "game":
gameMod.Errors++;
break;
default:
{
if (mods.ContainsKey(message.Mod))
mods[message.Mod].Errors++;
break;
}
}
}
// collect SMAPI metadata
if (message.Mod == "SMAPI")
{
// update flags
if (inModList && !this.ModListEntryPattern.IsMatch(message.Text))
inModList = false;
if (inContentPackList && !this.ContentPackListEntryPattern.IsMatch(message.Text))
inContentPackList = false;
if (inModUpdateList && !this.ModUpdateListEntryPattern.IsMatch(message.Text))
inModUpdateList = false;
// mod list
if (!inModList && message.Level == LogLevel.Info && this.ModListStartPattern.IsMatch(message.Text))
inModList = true;
else if (inModList)
{
Match match = this.ModListEntryPattern.Match(message.Text);
string name = match.Groups["name"].Value;
string version = match.Groups["version"].Value;
string author = match.Groups["author"].Value;
string description = match.Groups["description"].Value;
mods[name] = new LogModInfo { Name = name, Author = author, Version = version, Description = description, Loaded = true };
}
// content pack list
else if (!inContentPackList && message.Level == LogLevel.Info && this.ContentPackListStartPattern.IsMatch(message.Text))
inContentPackList = true;
else if (inContentPackList)
{
Match match = this.ContentPackListEntryPattern.Match(message.Text);
string name = match.Groups["name"].Value;
string version = match.Groups["version"].Value;
string author = match.Groups["author"].Value;
string description = match.Groups["description"].Value;
string forMod = match.Groups["for"].Value;
mods[name] = new LogModInfo { Name = name, Author = author, Version = version, Description = description, ContentPackFor = forMod, Loaded = true };
}
// mod update list
else if (!inModUpdateList && message.Level == LogLevel.Alert && this.ModUpdateListStartPattern.IsMatch(message.Text))
inModUpdateList = true;
else if (inModUpdateList)
{
Match match = this.ModUpdateListEntryPattern.Match(message.Text);
string name = match.Groups["name"].Value;
string version = match.Groups["version"].Value;
string link = match.Groups["link"].Value;
if (mods.ContainsKey(name))
{
mods[name].UpdateLink = link;
mods[name].UpdateVersion = version;
}
else
{
mods[name] = new LogModInfo {Name = name, UpdateVersion = version, UpdateLink = link, Loaded = false};
}
}
else if(message.Level == LogLevel.Alert && this.SMAPIUpdatePattern.IsMatch(message.Text))
{
Match match = this.SMAPIUpdatePattern.Match(message.Text);
string version = match.Groups["version"].Value;
string link = match.Groups["link"].Value;
smapiMod.UpdateVersion = version;
smapiMod.UpdateLink = link;
}
// platform info line
else if (message.Level == LogLevel.Info && this.InfoLinePattern.IsMatch(message.Text))
{
Match match = this.InfoLinePattern.Match(message.Text);
log.ApiVersion = match.Groups["apiVersion"].Value;
log.GameVersion = match.Groups["gameVersion"].Value;
log.OperatingSystem = match.Groups["os"].Value;
smapiMod.Version = log.ApiVersion;
}
// mod path line
else if (message.Level == LogLevel.Debug && this.ModPathPattern.IsMatch(message.Text))
{
Match match = this.ModPathPattern.Match(message.Text);
log.ModPath = match.Groups["path"].Value;
int lastDelimiterPos = log.ModPath.LastIndexOfAny(new char[] { '/', '\\' });
log.GamePath = lastDelimiterPos >= 0
? log.ModPath.Substring(0, lastDelimiterPos)
: log.ModPath;
}
// log UTC timestamp line
else if (message.Level == LogLevel.Trace && this.LogStartedAtPattern.IsMatch(message.Text))
{
Match match = this.LogStartedAtPattern.Match(message.Text);
log.Timestamp = DateTime.Parse(match.Groups["timestamp"].Value + "Z");
}
}
}
// finalise log
gameMod.Version = log.GameVersion;
log.Mods = new[] { gameMod, smapiMod }.Concat(mods.Values.OrderBy(p => p.Name)).ToArray();
return log;
}
catch (LogParseException ex)
{
return new ParsedLog
{
IsValid = false,
Error = ex.Message,
RawText = logText
};
}
catch (Exception ex)
{
return new ParsedLog
{
IsValid = false,
Error = $"Parsing the log file failed. Technical details:\n{ex}",
RawText = logText
};
}
}
/*********
** Private methods
*********/
/// Collapse consecutive repeats into the previous message.
/// The messages to filter.
private IEnumerable CollapseRepeats(IEnumerable messages)
{
LogMessage next = null;
foreach (LogMessage message in messages)
{
// new message
if (next == null)
{
next = message;
continue;
}
// repeat
if (next.Level == message.Level && next.Mod == message.Mod && next.Text == message.Text)
{
next.Repeated++;
continue;
}
// non-repeat message
yield return next;
next = message;
}
yield return next;
}
/// Split a SMAPI log into individual log messages.
/// The SMAPI log text.
/// The log text can't be parsed successfully.
private IEnumerable GetMessages(string logText)
{
LogMessage message = new LogMessage();
using (StringReader reader = new StringReader(logText))
{
while (true)
{
// read data
string line = reader.ReadLine();
if (line == null)
break;
Match header = this.MessageHeaderPattern.Match(line);
// validate
if (message.Text == null && !header.Success)
throw new LogParseException("Found a log message with no SMAPI metadata. Is this a SMAPI log file?");
// start or continue message
if (header.Success)
{
if (message.Text != null)
yield return message;
message = new LogMessage
{
Time = header.Groups["time"].Value,
Level = Enum.Parse(header.Groups["level"].Value, ignoreCase: true),
Mod = header.Groups["modName"].Value,
Text = line.Substring(header.Length)
};
}
else
message.Text += "\n" + line;
}
// end last message
if (message.Text != null)
yield return message;
}
}
}
}