This repository has been archived on 2026-06-12. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
Xorog.Logger/LoggerClient.cs
2023-08-23 04:26:20 +02:00

696 lines
26 KiB
C#

using Newtonsoft.Json;
using Xorog.Logger.EventArgs;
namespace Xorog.Logger;
public sealed class LoggerClient : ILogger
{
internal LoggerClient() { }
/// <summary>
/// The <see cref="ILoggerProvider"/>.
/// </summary>
public LoggerProvider Provider { get; internal set; }
private bool LoggerStarted = false;
private CustomLogLevel MaxLogLevel = CustomLogLevel.Debug;
private string FileName = "";
private FileStream OpenedFile { get; set; }
internal List<LogEntry> LogsToPost = new();
internal List<string> Blacklist = new();
internal List<CustomLogLevel> FileBlackList = new();
private Task RunningLogger = null;
/// <summary>
/// Fired when a log message has been sent.
/// </summary>
public event EventHandler<LogMessageEventArgs> LogRaised;
/// <summary>
/// Starts the logger with specified settings
/// </summary>
/// <param name="filePath">Where the current logs should be saved to, leave blank if logs shouldnt be saved</param>
/// <param name="level">The loglevel that should be displayed in the console, does not affect whats written to file</param>
/// <param name="cleanUpBefore">Clean up old logs before a datetime</param>
/// <returns>A bool stating if the logger was started</returns>
public static LoggerClient StartLogger(string filePath = "", CustomLogLevel level = CustomLogLevel.Debug, DateTime cleanUpBefore = new DateTime(), bool ThrowOnFailedDeletion = false)
{
DirectoryInfo directoryInfo = new(new FileInfo(filePath).DirectoryName);
if (!directoryInfo.Exists)
directoryInfo.Create();
filePath = filePath.Replace("\\", "/");
var handler = new LoggerClient();
handler.Provider = new(handler);
if (handler.LoggerStarted)
throw new Exception($"The logger is already started");
if (filePath is not "")
{
if (filePath.Contains('/'))
{
var dirPath = filePath[..filePath.LastIndexOf('/')];
if (!Directory.Exists(dirPath))
_ = Directory.CreateDirectory(dirPath);
}
handler.FileName = filePath;
handler.OpenedFile = File.Open(handler.FileName, FileMode.CreateNew, FileAccess.ReadWrite, FileShare.Read);
}
handler.LoggerStarted = true;
handler.MaxLogLevel = level;
if (cleanUpBefore != new DateTime())
{
foreach (var b in Directory.GetFiles(new FileInfo(filePath).Directory.FullName))
{
try
{
FileInfo fi = new(b);
if (fi.CreationTimeUtc < cleanUpBefore)
{
fi.Delete();
handler.LogDebug($"{fi.Name} deleted");
}
}
catch (Exception ex)
{
if (!ThrowOnFailedDeletion)
handler.LogError( $"Couldn't delete log file {b}", ex);
else
throw new Exception($"Failed to delete {b}: {ex}");
}
}
}
handler.RunningLogger = Task.Run(async () =>
{
while (handler.LoggerStarted)
{
try
{
while (handler.LogsToPost.Count == 0)
{
Thread.Sleep(10);
}
for (var i = 0; i < handler.LogsToPost.Count; i++)
{
var currentLog = handler.LogsToPost[0];
_ = handler.LogsToPost.Remove(currentLog);
if (currentLog is null || currentLog.RawMessage is null)
{
continue;
}
var LogLevelText = $"{currentLog.LogLevel,-6}";
ConsoleColor LogLevelColor;
ConsoleColor BackgroundColor;
LogLevelColor = currentLog.LogLevel switch
{
CustomLogLevel.Trace => ConsoleColor.Gray,
CustomLogLevel.Debug2 => ConsoleColor.Gray,
CustomLogLevel.Debug => ConsoleColor.Gray,
CustomLogLevel.Info => ConsoleColor.Cyan,
CustomLogLevel.Warn => ConsoleColor.Yellow,
CustomLogLevel.Error => ConsoleColor.Red,
CustomLogLevel.Fatal => ConsoleColor.Black,
_ => ConsoleColor.Gray
};
BackgroundColor = currentLog.LogLevel switch
{
CustomLogLevel.Fatal => ConsoleColor.DarkRed,
_ => ConsoleColor.Black
};
var leftOver = currentLog.RawMessage;
foreach (var blacklistobject in handler.Blacklist)
leftOver = leftOver.Replace(blacklistobject, new String('*', blacklistobject.Length), StringComparison.CurrentCultureIgnoreCase);
var currentArg = 0;
var inTemplate = false;
var attemptedParsing = false;
List<StringPart> builder = new();
while (leftOver.Length > 0)
{
if (inTemplate)
{
attemptedParsing = true;
if (currentLog.Args?.Length >= currentArg && currentLog.Args?.Length != 0)
{
try
{
var endIndex = leftOver.IndexOf('}');
if (currentArg > currentLog.Args.Length)
continue;
var objectToAdd = currentLog.Args[currentArg];
currentArg++;
if (objectToAdd is null)
continue;
if (objectToAdd.GetType() == typeof(int))
builder.Add(new StringPart { String = objectToAdd.ToString(), Color = ConsoleColor.Magenta });
else if (objectToAdd.GetType() == typeof(long))
builder.Add(new StringPart { String = objectToAdd.ToString(), Color = ConsoleColor.Magenta });
else if (objectToAdd.GetType() == typeof(uint))
builder.Add(new StringPart { String = objectToAdd.ToString(), Color = ConsoleColor.Magenta });
else if (objectToAdd.GetType() == typeof(ulong))
builder.Add(new StringPart { String = objectToAdd.ToString(), Color = ConsoleColor.Magenta });
else
builder.Add(new StringPart { String = objectToAdd.ToString(), Color = ConsoleColor.Cyan });
inTemplate = false;
leftOver = leftOver[(endIndex + 1)..];
attemptedParsing = false;
}
catch (Exception)
{
currentArg++;
continue;
}
continue;
}
}
inTemplate = false;
var placeholderIndex = leftOver.IndexOf('{');
if (placeholderIndex != -1)
inTemplate = true;
if (placeholderIndex == -1 || placeholderIndex > leftOver.Length)
placeholderIndex = leftOver.Length;
if (placeholderIndex == 0 && attemptedParsing)
placeholderIndex = leftOver.Length;
var str = leftOver[..placeholderIndex];
if (!string.IsNullOrEmpty(str))
builder.Add(new StringPart { String = str });
leftOver = leftOver[placeholderIndex..];
attemptedParsing = false;
}
if (handler.MaxLogLevel >= currentLog.LogLevel)
{
Console.ResetColor(); Console.Write($"[{currentLog.TimeOfEvent:dd.MM.yyyy HH:mm:ss:fff}] ");
Console.ForegroundColor = LogLevelColor; Console.BackgroundColor = BackgroundColor; Console.Write($"[{LogLevelText}]"); Console.ResetColor(); Console.Write(" ");
foreach (var part in builder)
{
Console.ForegroundColor = part.Color ?? ConsoleColor.White;
Console.BackgroundColor = ConsoleColor.Black;
Console.Write($"{part.String}");
}
Console.ResetColor();
Console.WriteLine();
if (currentLog.Exception is not null)
try
{
Console.WriteLine(JsonConvert.SerializeObject(currentLog.Exception, Formatting.Indented, new JsonSerializerSettings()
{
NullValueHandling = NullValueHandling.Ignore,
ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
Error = (serializer, err) => err.ErrorContext.Handled = true
}));
}
catch (Exception)
{
Console.WriteLine(currentLog.Exception);
}
}
currentLog.Message = string.Join("", builder.Select(x => x.String));
for (var i1 = 0; i1 < builder.Count; i1++)
{
builder[i1].Dispose();
}
builder.Clear();
_ = Task.Run(() => handler.LogRaised?.Invoke(null, new LogMessageEventArgs() { LogEntry = currentLog }));
try
{
if (!handler.FileBlackList.Contains(currentLog.LogLevel))
{
var FileWrite = Encoding.UTF8.GetBytes($"[{currentLog.TimeOfEvent:dd.MM.yyyy HH:mm:ss:fff}] [{LogLevelText}] {currentLog.Message}\n{(currentLog.Exception is not null ? $"{currentLog.Exception}\n" : "")}");
if (handler.OpenedFile != null)
{
await handler.OpenedFile.WriteAsync(FileWrite.AsMemory(0, FileWrite.Length));
handler.OpenedFile.Flush();
}
}
}
catch (Exception ex)
{
handler.LogFatal($"Couldn't write log to file: {ex}");
}
}
}
catch (Exception ex)
{
handler.LogError("An exception occurred while trying to display a log message", ex);
await Task.Delay(1000);
continue;
}
}
});
return handler;
}
/// <summary>
/// Stops the logger
/// </summary>
public void StopLogger()
{
LoggerStarted = false;
MaxLogLevel = CustomLogLevel.Debug;
FileName = "";
Thread.Sleep(500);
RunningLogger?.Dispose();
RunningLogger = null;
this.OpenedFile?.Close();
}
/// <summary>
/// Add strings automatically censor on output to console and file.
/// </summary>
/// <param name="blacklist">The strings to censor</param>
public void AddBlacklist(params string[] blacklist)
{
for (var i = 0; i < blacklist.Length; i++)
{
if (!string.IsNullOrWhiteSpace(blacklist[i]))
Blacklist.Add(blacklist[i]);
}
}
/// <summary>
/// Add blacklisted log level to not save
/// </summary>
/// <param name="levels">The log levels not to save to the log file</param>
public void AddLogLevelBlacklist(params CustomLogLevel[] levels)
{
for (var i = 0; i < levels.Length; i++)
{
FileBlackList.Add(levels[i]);
}
}
/// <summary>
/// Changes the log level
/// </summary>
/// <param name="level">The new log level to apply</param>
public void ChangeLogLevel(CustomLogLevel level) => MaxLogLevel = level;
/// <summary>
/// Log with none log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogNone(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.None,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with none log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogNone(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.None,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with none log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogNone(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.None,
RawMessage = message,
Args = args
});
/// <summary>
/// Log with trace log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogTrace(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Trace,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with trace log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogTrace(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Trace,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with trace log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogTrace(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Trace,
RawMessage = message,
Args = args,
});
/// <summary>
/// Log with debug2 log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogDebug2(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Debug2,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with debug2 log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogDebug2(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Debug2,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with debug2 log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogDebug2(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Debug2,
RawMessage = message,
Args = args
});
/// <summary>
/// Log with debug log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogDebug(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Debug,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with debug log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogDebug(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Debug,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with debug log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogDebug(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Debug,
RawMessage = message,
Args = args
});
/// <summary>
/// Log with info log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogInfo(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Info,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with info log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogInfo(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Info,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with info log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogInfo(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Info,
RawMessage = message,
Args = args
});
/// <summary>
/// Log with warn log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogWarn(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Warn,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with warn log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogWarn(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Warn,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with warn log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogWarn(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Warn,
RawMessage = message,
Args = args
});
/// <summary>
/// Log with error log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogError(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Error,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with error log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogError(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Error,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with error log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogError(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Error,
RawMessage = message,
Args = args
});
/// <summary>
/// Log with fatal log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
/// <param name="args">The objects involved in the event</param>
public void LogFatal(string message, Exception? exception = null, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Fatal,
RawMessage = message,
Args = args,
Exception = exception
});
/// <summary>
/// Log with fatal log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="exception">The exception that was caused</param>
public void LogFatal(string message, Exception? exception = null) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Fatal,
RawMessage = message,
Exception = exception
});
/// <summary>
/// Log with fatal log level
/// </summary>
/// <param name="message">The message to display</param>
/// <param name="args">The objects involved in the event</param>
public void LogFatal(string message, params object[] args) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = CustomLogLevel.Fatal,
RawMessage = message,
Args = args
});
/// <summary>
/// Log with standard Microsoft.Extensions.Logging format
/// </summary>
/// <typeparam name="TState"></typeparam>
/// <param name="logLevel"></param>
/// <param name="eventId"></param>
/// <param name="state"></param>
/// <param name="exception"></param>
/// <param name="formatter"></param>
public void Log<TState>(Microsoft.Extensions.Logging.LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter) => LogsToPost.Add(new LogEntry
{
TimeOfEvent = DateTime.Now,
LogLevel = logLevel switch
{
Microsoft.Extensions.Logging.LogLevel.Debug => CustomLogLevel.Debug2,
Microsoft.Extensions.Logging.LogLevel.Trace => CustomLogLevel.Trace2,
Microsoft.Extensions.Logging.LogLevel.Information => CustomLogLevel.Info,
Microsoft.Extensions.Logging.LogLevel.Warning => CustomLogLevel.Warn,
Microsoft.Extensions.Logging.LogLevel.Error => CustomLogLevel.Error,
Microsoft.Extensions.Logging.LogLevel.Critical => CustomLogLevel.Fatal,
Microsoft.Extensions.Logging.LogLevel.None => CustomLogLevel.None,
_ => CustomLogLevel.None,
},
RawMessage = $"[{eventId.Id}] {formatter(state, exception)}",
Exception = exception
});
public bool IsEnabled(Microsoft.Extensions.Logging.LogLevel logLevel)
=> LoggerStarted;
public IDisposable BeginScope<TState>(TState state)
=> default!;
}