t0w0bi/ClubPenguinClient
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Loggerrework (#45)

Browse Source 
* test some refactoring for cachedplayer

* rework logging

* fix saving of log level

---------

Co-authored-by: rootdarkarchon <root.darkarchon@outlook.com>
This commit is contained in:
rootdarkarchon
2023-02-18 15:23:38 +01:00
committed by GitHub
parent 7f36e80e2a
commit 2ae5d42e4d
49 changed files with 676 additions and 691 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
MareSynchronos/Utils/DalamudLogger.cs Normal file
View File

@@ -0,0 +1,38 @@
using Dalamud.Logging;
using MareSynchronos.MareConfiguration;
using Microsoft.Extensions.Logging;
namespace MareSynchronos.Utils;
internal class DalamudLogger : ILogger
{
private readonly string _name;
private readonly MareConfigService _mareConfigService;
public DalamudLogger(string name, MareConfigService mareConfigService)
{
this._name = name;
_mareConfigService = mareConfigService;
}
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
{
if (!IsEnabled(logLevel)) return;
if (exception == null)
PluginLog.Information($"[{_name}]{{{(int)logLevel}}} {formatter(state, exception)}");
else if (logLevel == LogLevel.Warning)
PluginLog.Warning($"[{_name}]{{{(int)logLevel}}} {formatter(state, exception)}");
else if (logLevel == LogLevel.Error)
PluginLog.Error($"[{_name}]{{{(int)logLevel}}} {formatter(state, exception)}");
else
PluginLog.Fatal($"[{_name}]{{{(int)logLevel}}} {formatter(state, exception)}");
}
public bool IsEnabled(LogLevel logLevel)
{
return (int)_mareConfigService.Current.LogLevel <= (int)logLevel;
}
public IDisposable BeginScope<TState>(TState state) => default!;
}

20
MareSynchronos/Utils/DalamudLoggingProvider.cs
View File

@@ -1,4 +1,5 @@
using System.Collections.Concurrent;
using MareSynchronos.MareConfiguration;
using Microsoft.Extensions.Logging;
namespace MareSynchronos.Utils;
@@ -6,21 +7,32 @@ namespace MareSynchronos.Utils;
[ProviderAlias("Dalamud")]
public class DalamudLoggingProvider : ILoggerProvider
{
private readonly ConcurrentDictionary<string, Logger> _loggers =
private readonly ConcurrentDictionary<string, DalamudLogger> _loggers =
new(StringComparer.OrdinalIgnoreCase);
private readonly MareConfigService _mareConfigService;
public DalamudLoggingProvider()
public DalamudLoggingProvider(MareConfigService mareConfigService)
{
_mareConfigService = mareConfigService;
}
public ILogger CreateLogger(string categoryName)
{
return _loggers.GetOrAdd(categoryName, name => new Logger(categoryName));
string catName = categoryName.Split(".", StringSplitOptions.RemoveEmptyEntries).Last();
if (catName.Length > 15)
{
catName = string.Join("", catName.Take(6)) + "..." + string.Join("", catName.TakeLast(6));
}
else
{
catName = string.Join("", Enumerable.Range(0, 15 - catName.Length).Select(_ => " ")) + catName;
}
return _loggers.GetOrAdd(catName, name => new DalamudLogger(catName, _mareConfigService));
}
public void Dispose()
{
Logger.Verbose($"Disposing {GetType()}");
_loggers.Clear();
}
}

17
MareSynchronos/Utils/DalamudLoggingProviderExtensions.cs Normal file
View File

@@ -0,0 +1,17 @@
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Logging;
namespace MareSynchronos.Utils;
public static class DalamudLoggingProviderExtensions
{
public static ILoggingBuilder AddDalamudLogging(this ILoggingBuilder builder)
{
builder.ClearProviders();
builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, DalamudLoggingProvider>());
return builder;
}
}

40
MareSynchronos/Utils/DalamudUtil.cs
View File

@@ -5,15 +5,16 @@ using Dalamud.Game.ClientState.Objects;
using Dalamud.Game.ClientState.Objects.SubKinds;
using FFXIVClientStructs.FFXIV.Client.Game.Character;
using FFXIVClientStructs.FFXIV.Client.Game.Control;
using FFXIVClientStructs.FFXIV.Client.Graphics.Scene;
using MareSynchronos.Mediator;
using MareSynchronos.Models;
using Microsoft.Extensions.Logging;
using GameObject = FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject;
namespace MareSynchronos.Utils;
public class DalamudUtil : IDisposable
{
private readonly ILogger<DalamudUtil> _logger;
private readonly ClientState _clientState;
private readonly ObjectTable _objectTable;
private readonly Framework _framework;
@@ -39,9 +40,10 @@ public class DalamudUtil : IDisposable
return false;
}
public DalamudUtil(ClientState clientState, ObjectTable objectTable, Framework framework,
public DalamudUtil(ILogger<DalamudUtil> logger, ClientState clientState, ObjectTable objectTable, Framework framework,
Condition condition, Dalamud.Data.DataManager gameData, MareMediator mediator)
{
_logger = logger;
_clientState = clientState;
_objectTable = objectTable;
_framework = framework;
@@ -66,20 +68,20 @@ public class DalamudUtil : IDisposable
{
if (GposeTarget != null && !IsInGpose)
{
Logger.Debug("Gpose start");
_logger.LogDebug("Gpose start");
IsInGpose = true;
_mediator.Publish(new GposeStartMessage());
}
else if (GposeTarget == null && IsInGpose)
{
Logger.Debug("Gpose end");
_logger.LogDebug("Gpose end");
IsInGpose = false;
_mediator.Publish(new GposeEndMessage());
}
if (_condition[ConditionFlag.WatchingCutscene] && !IsInCutscene)
{
Logger.Debug("Cutscene start");
_logger.LogDebug("Cutscene start");
IsInCutscene = true;
_mediator.Publish(new CutsceneStartMessage());
_mediator.Publish(new HaltScanMessage("Cutscene"));
@@ -87,7 +89,7 @@ public class DalamudUtil : IDisposable
}
else if (!_condition[ConditionFlag.WatchingCutscene] && IsInCutscene)
{
Logger.Debug("Cutscene end");
_logger.LogDebug("Cutscene end");
IsInCutscene = false;
_mediator.Publish(new CutsceneEndMessage());
_mediator.Publish(new ResumeScanMessage("Cutscene"));
@@ -99,7 +101,7 @@ public class DalamudUtil : IDisposable
{
if (!_sentBetweenAreas)
{
Logger.Debug("Zone switch/Gpose start");
_logger.LogDebug("Zone switch/Gpose start");
_sentBetweenAreas = true;
_mediator.Publish(new ZoneSwitchStartMessage());
_mediator.Publish(new HaltScanMessage("Zone switch"));
@@ -110,7 +112,7 @@ public class DalamudUtil : IDisposable
if (_sentBetweenAreas)
{
Logger.Debug("Zone switch/Gpose end");
_logger.LogDebug("Zone switch/Gpose end");
_sentBetweenAreas = false;
_mediator.Publish(new ZoneSwitchEndMessage());
_mediator.Publish(new ResumeScanMessage("Zone switch"));
@@ -124,13 +126,13 @@ public class DalamudUtil : IDisposable
if (localPlayer != null && !IsLoggedIn)
{
Logger.Debug("Logged in");
_logger.LogDebug("Logged in");
IsLoggedIn = true;
_mediator.Publish(new DalamudLoginMessage());
}
else if (localPlayer == null && IsLoggedIn)
{
Logger.Debug("Logged out");
_logger.LogDebug("Logged out");
IsLoggedIn = false;
_mediator.Publish(new DalamudLogoutMessage());
}
@@ -250,11 +252,11 @@ public class DalamudUtil : IDisposable
return await _framework.RunOnFrameworkThread(func).ConfigureAwait(false);
}
public unsafe void WaitWhileCharacterIsDrawing(GameObjectHandler handler, int timeOut = 5000, CancellationToken? ct = null)
public unsafe void WaitWhileCharacterIsDrawing(ILogger logger, GameObjectHandler handler, Guid redrawId, int timeOut = 5000, CancellationToken? ct = null)
{
if (!_clientState.IsLoggedIn || handler.Address == IntPtr.Zero) return;
Logger.Verbose($"Starting wait for {handler} to draw");
logger.LogTrace($"[{redrawId}] Starting wait for {handler} to draw");
const int tick = 250;
int curWaitTime = 0;
@@ -265,18 +267,20 @@ public class DalamudUtil : IDisposable
&& curWaitTime < timeOut
&& handler.IsBeingDrawn) // 0b100000000000 is "still rendering" or something
{
Logger.Verbose($"Waiting for {handler} to finish drawing");
logger.LogTrace($"[{redrawId}] Waiting for {handler} to finish drawing");
curWaitTime += tick;
Thread.Sleep(tick);
}
logger.LogTrace($"[{redrawId}] Finished drawing after {curWaitTime}ms");
}
catch (NullReferenceException ex)
{
Logger.Warn("Error accessing " + handler + ", object does not exist anymore?", ex);
logger.LogWarning("Error accessing " + handler + ", object does not exist anymore?", ex);
}
catch (AccessViolationException ex)
{
Logger.Warn("Error accessing " + handler + ", object does not exist anymore?", ex);
logger.LogWarning("Error accessing " + handler + ", object does not exist anymore?", ex);
}
}
@@ -286,11 +290,11 @@ public class DalamudUtil : IDisposable
var obj = (GameObject*)characterAddress;
const int tick = 250;
int curWaitTime = 0;
Logger.Verbose("RenderFlags:" + obj->RenderFlags.ToString("X"));
_logger.LogTrace("RenderFlags:" + obj->RenderFlags.ToString("X"));
// ReSharper disable once LoopVariableIsNeverChangedInsideLoop
while (obj->RenderFlags != 0x00 && curWaitTime < timeOut)
{
Logger.Verbose($"Waiting for gpose actor to finish drawing");
_logger.LogTrace($"Waiting for gpose actor to finish drawing");
curWaitTime += tick;
Thread.Sleep(tick);
}
@@ -300,7 +304,7 @@ public class DalamudUtil : IDisposable
public void Dispose()
{
Logger.Verbose($"Disposing {GetType()}");
_logger.LogTrace($"Disposing {GetType()}");
_framework.Update -= FrameworkOnUpdate;
}
}

106
MareSynchronos/Utils/Logger.cs
View File

@@ -1,106 +0,0 @@
using System.Diagnostics;
using Dalamud.Logging;
using Dalamud.Utility;
using Microsoft.Extensions.Logging;
namespace MareSynchronos.Utils;
internal class Logger : ILogger
{
private readonly string _name;
public static void Info(string? info)
{
var caller = new StackTrace().GetFrame(1)?.GetMethod()?.ReflectedType?.Name ?? "Unknown";
PluginLog.Information($"[{caller}] {info}");
}
public static void Debug(string? debug, string stringToHighlight = "")
{
var caller = new StackTrace().GetFrame(1)?.GetMethod()?.ReflectedType?.Name ?? "Unknown";
if (debug != null && debug.Contains(stringToHighlight, StringComparison.Ordinal) && !stringToHighlight.IsNullOrEmpty())
{
PluginLog.Warning($"[{caller}] {debug}");
}
else
{
PluginLog.Debug($"[{caller}] {debug}");
}
}
public static void Error(string? msg, Exception ex)
{
var caller = new StackTrace().GetFrame(1)?.GetMethod()?.ReflectedType?.Name ?? "Unknown";
PluginLog.Error($"[{caller}] {msg} {Environment.NewLine} Exception: {ex?.ToString()}");
}
public static void Warn(string? msg, Exception ex)
{
var caller = new StackTrace().GetFrame(1)?.GetMethod()?.ReflectedType?.Name ?? "Unknown";
PluginLog.Warning($"[{caller}] {msg} {Environment.NewLine} Exception: {ex?.ToString()}");
}
public static void Error(string? msg)
{
var caller = new StackTrace().GetFrame(1)?.GetMethod()?.ReflectedType?.Name ?? "Unknown";
PluginLog.Error($"[{caller}] {msg}");
}
public static void Warn(string? warn)
{
var caller = new StackTrace().GetFrame(1)?.GetMethod()?.ReflectedType?.Name ?? "Unknown";
PluginLog.Warning($"[{caller}] {warn}");
}
public static void Verbose(string? verbose)
{
var caller = new StackTrace().GetFrame(1)?.GetMethod()?.ReflectedType?.Name ?? "Unknown";
#if DEBUG
PluginLog.Debug($"[{caller}] {verbose}");
#else
PluginLog.Verbose($"[{caller}] {verbose}");
#endif
}
public Logger(string name)
{
this._name = name;
}
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
{
if (!IsEnabled(logLevel)) return;
switch (logLevel)
{
case LogLevel.Debug:
Debug($"[{_name}] [{eventId}] {formatter(state, exception)}");
break;
case LogLevel.Error:
case LogLevel.Critical:
Error($"[{_name}] [{eventId}] {formatter(state, exception)}", exception);
break;
case LogLevel.Information:
Info($"[{_name}] [{eventId}] {formatter(state, exception)}");
break;
case LogLevel.Warning:
Warn($"[{_name}] [{eventId}] {formatter(state, exception)}", exception);
break;
case LogLevel.Trace:
default:
#if DEBUG
PluginLog.Verbose($"[{_name}] [{eventId}] {formatter(state, exception)}");
#else
PluginLog.Verbose($"[{_name}] {eventId} {state} {formatter(state, exception)}");
#endif
break;
}
}
public bool IsEnabled(LogLevel logLevel)
{
return true;
}
public IDisposable BeginScope<TState>(TState state) => default!;
}