From 8a9b2a3757fb491a3482ee34621158c65bf57d7e Mon Sep 17 00:00:00 2001 From: Liza Carvelli Date: Sat, 25 Feb 2023 15:24:01 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=89=20Initial=20Commit?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 340 ++++++++++++++++++ Dalamud.Extensions.MicrosoftLogging.sln | 16 + ...Dalamud.Extensions.MicrosoftLogging.csproj | 36 ++ .../DalamudLogger.cs | 94 +++++ .../DalamudLoggerExtensions.cs | 19 + .../DalamudLoggerProvider.cs | 43 +++ LICENSE | 21 ++ README.md | 3 + 8 files changed, 572 insertions(+) create mode 100644 .gitignore create mode 100644 Dalamud.Extensions.MicrosoftLogging.sln create mode 100644 Dalamud.Extensions.MicrosoftLogging/Dalamud.Extensions.MicrosoftLogging.csproj create mode 100644 Dalamud.Extensions.MicrosoftLogging/DalamudLogger.cs create mode 100644 Dalamud.Extensions.MicrosoftLogging/DalamudLoggerExtensions.cs create mode 100644 Dalamud.Extensions.MicrosoftLogging/DalamudLoggerProvider.cs create mode 100644 LICENSE create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4ce6fdd --- /dev/null +++ b/.gitignore @@ -0,0 +1,340 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- Backup*.rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb \ No newline at end of file diff --git a/Dalamud.Extensions.MicrosoftLogging.sln b/Dalamud.Extensions.MicrosoftLogging.sln new file mode 100644 index 0000000..ca068aa --- /dev/null +++ b/Dalamud.Extensions.MicrosoftLogging.sln @@ -0,0 +1,16 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dalamud.Extensions.MicrosoftLogging", "Dalamud.Extensions.MicrosoftLogging\Dalamud.Extensions.MicrosoftLogging.csproj", "{DC1AFB3A-DC8E-4E7D-8085-4D853B4E9C9A}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {DC1AFB3A-DC8E-4E7D-8085-4D853B4E9C9A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {DC1AFB3A-DC8E-4E7D-8085-4D853B4E9C9A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {DC1AFB3A-DC8E-4E7D-8085-4D853B4E9C9A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {DC1AFB3A-DC8E-4E7D-8085-4D853B4E9C9A}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/Dalamud.Extensions.MicrosoftLogging/Dalamud.Extensions.MicrosoftLogging.csproj b/Dalamud.Extensions.MicrosoftLogging/Dalamud.Extensions.MicrosoftLogging.csproj new file mode 100644 index 0000000..93eea18 --- /dev/null +++ b/Dalamud.Extensions.MicrosoftLogging/Dalamud.Extensions.MicrosoftLogging.csproj @@ -0,0 +1,36 @@ + + + + net7.0 + enable + enable + + + + Dalamud.Extensions.MicrosoftLogging + 1.0.0 + Liza Carvelli + MIT + https://github.com/carvelli/Dalamud.Extensions.MicrosoftLogging + https://github.com/carvelli/Dalamud.Extensions.MicrosoftLogging.git + git + true + portable + $(SolutionDir)=X:\ + + + + + + + + + $(AppData)\XIVLauncher\addon\Hooks\dev\Dalamud.dll + false + + + $(AppData)\XIVLauncher\addon\Hooks\dev\Serilog.dll + false + + + diff --git a/Dalamud.Extensions.MicrosoftLogging/DalamudLogger.cs b/Dalamud.Extensions.MicrosoftLogging/DalamudLogger.cs new file mode 100644 index 0000000..4fbfef2 --- /dev/null +++ b/Dalamud.Extensions.MicrosoftLogging/DalamudLogger.cs @@ -0,0 +1,94 @@ +using System.Reflection; +using Microsoft.Extensions.Logging; +using System.Text; +using Serilog.Events; + +namespace Dalamud.Extensions.MicrosoftLogging +{ + public sealed class DalamudLogger : ILogger + { + private readonly string _name; + private readonly string _assemblyName; + private readonly IExternalScopeProvider? _scopeProvider; + private readonly Serilog.ILogger _pluginLogDelegate; + + public DalamudLogger(string name, Assembly assembly, IExternalScopeProvider? scopeProvider) + { + _name = name; + _assemblyName = assembly.GetName().Name ?? + typeof(DalamudLogger).Assembly.GetName().Name ?? + "{unknown DalamudLogger}"; + _scopeProvider = scopeProvider; + _pluginLogDelegate = + Serilog.Log.ForContext("SourceContext", _assemblyName); + } + + public IDisposable BeginScope(TState state) + where TState : notnull + => _scopeProvider?.Push(state) ?? NullScope.Instance; + + public bool IsEnabled(LogLevel logLevel) => logLevel != LogLevel.None && IsEnabled(ToSerilogLevel(logLevel)); + + private bool IsEnabled(LogEventLevel logEventLevel) => _pluginLogDelegate.IsEnabled(logEventLevel); + + public void Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, + Func formatter) + { + if (logLevel == LogLevel.None) + return; + + LogEventLevel logEventLevel = ToSerilogLevel(logLevel); + if (!IsEnabled(logEventLevel)) + return; + + if (formatter == null) + throw new ArgumentNullException(nameof(formatter)); + + StringBuilder sb = new StringBuilder(); + sb.Append('[').Append(_assemblyName).Append("] "); + _scopeProvider?.ForEachScope((scope, builder) => + { + if (scope is IEnumerable> properties) + { + foreach (KeyValuePair pair in properties) + { + builder.Append('<').Append(pair.Key).Append('=').Append(pair.Value) + .Append("> "); + } + } + else if (scope != null) + builder.Append('<').Append(scope).Append("> "); + }, + sb); + sb.Append(_name).Append(": ").Append(formatter(state, null)); + _pluginLogDelegate.Write(logEventLevel, exception, sb.ToString()); + } + + private LogEventLevel ToSerilogLevel(LogLevel logLevel) + { + return logLevel switch + { + LogLevel.Critical => LogEventLevel.Fatal, + LogLevel.Error => LogEventLevel.Error, + LogLevel.Warning => LogEventLevel.Warning, + LogLevel.Information => LogEventLevel.Information, + LogLevel.Debug => LogEventLevel.Debug, + LogLevel.Trace => LogEventLevel.Verbose, + _ => throw new ArgumentOutOfRangeException(nameof(logLevel), logLevel, null) + }; + } + + private sealed class NullScope : IDisposable + { + public static NullScope Instance { get; } = new(); + + private NullScope() + { + } + + public void Dispose() + { + } + } + } +} diff --git a/Dalamud.Extensions.MicrosoftLogging/DalamudLoggerExtensions.cs b/Dalamud.Extensions.MicrosoftLogging/DalamudLoggerExtensions.cs new file mode 100644 index 0000000..b27ba39 --- /dev/null +++ b/Dalamud.Extensions.MicrosoftLogging/DalamudLoggerExtensions.cs @@ -0,0 +1,19 @@ +using Dalamud.Plugin; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.DependencyInjection.Extensions; +using Microsoft.Extensions.Logging; + +namespace Dalamud.Extensions.MicrosoftLogging +{ + public static class DalamudLoggerExtensions + { + public static ILoggingBuilder AddDalamudLogger( + this ILoggingBuilder builder, IDalamudPlugin dalamudPlugin) + { + builder.Services.TryAddEnumerable( + ServiceDescriptor.Singleton( + new DalamudLoggerProvider(dalamudPlugin.GetType().Assembly))); + return builder; + } + } +} diff --git a/Dalamud.Extensions.MicrosoftLogging/DalamudLoggerProvider.cs b/Dalamud.Extensions.MicrosoftLogging/DalamudLoggerProvider.cs new file mode 100644 index 0000000..2e89ab8 --- /dev/null +++ b/Dalamud.Extensions.MicrosoftLogging/DalamudLoggerProvider.cs @@ -0,0 +1,43 @@ +using System.Reflection; +using Microsoft.Extensions.Logging; + +namespace Dalamud.Extensions.MicrosoftLogging +{ + public sealed class DalamudLoggerProvider : ILoggerProvider, ISupportExternalScope + { + private readonly Assembly _assembly; + private IExternalScopeProvider? _scopeProvider; + + public DalamudLoggerProvider(Assembly assembly) + { + _assembly = assembly; + } + + ILogger ILoggerProvider.CreateLogger(string categoryName) + => CreateLoggerImpl(categoryName); + + /// + /// Manual logger creation, doesn't handle scopes. + /// + public ILogger CreateLogger(Type type) + => CreateLoggerImpl(type.FullName ?? type.ToString()); + + /// + /// Manual logger creation, doesn't handle scopes. + /// + public ILogger CreateLogger() + => CreateLoggerImpl(typeof(T).FullName ?? typeof(T).ToString()); + + private ILogger CreateLoggerImpl(string categoryName) + => new DalamudLogger(categoryName, _assembly, _scopeProvider); + + public void SetScopeProvider(IExternalScopeProvider scopeProvider) + { + _scopeProvider = scopeProvider; + } + + public void Dispose() + { + } + } +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9ddebba --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Liza Carvelli + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..538c3fb --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Dalamud.Extensions.MicrosoftLogging + +Configures Microsoft.Extensions.Logging to write to Dalamud's plugin log.