Change to NLog instead of log4net.

Nihlus · Feb 2, 2018 · ec8c6cb · ec8c6cb
1 parent ac81a35
commit ec8c6cb
Show file tree

Hide file tree

Showing 20 changed files with 85 additions and 123 deletions.
diff --git a/.idea/.idea.Launchpad/.idea/contentModel.xml b/.idea/.idea.Launchpad/.idea/contentModel.xml
diff --git a/Launchpad.Common/Handlers/Manifest/ManifestHandler.cs b/Launchpad.Common/Handlers/Manifest/ManifestHandler.cs
@@ -25,7 +25,6 @@
 using System.IO;
 
 using Launchpad.Common.Enums;
-using log4net;
 
 namespace Launchpad.Common.Handlers.Manifest
 {
@@ -34,11 +33,6 @@ namespace Launchpad.Common.Handlers.Manifest
 	/// </summary>
 	public sealed class ManifestHandler
 	{
-		/// <summary>
-		/// Logger instance for this class.
-		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(ManifestHandler));
-
 		private readonly object ManifestsLock = new object();
 
 		/// <summary>
@@ -128,34 +122,20 @@ public void ReloadManifests(EManifestType manifestType)
 				var oldManifestPath = GetManifestPath(manifestType, true);
 
 				// Reload new manifests
-				try
-				{
-					if (!File.Exists(newManifestPath))
-					{
-						this.Manifests.AddOrUpdate(manifestType, null);
-					}
-
-					this.Manifests.AddOrUpdate(manifestType, LoadManifest(newManifestPath));
-				}
-				catch (IOException ioex)
+				if (!File.Exists(newManifestPath))
 				{
-					Log.Warn($"Could not load manifest of type {manifestType} (IOException): " + ioex.Message);
+					this.Manifests.AddOrUpdate(manifestType, null);
 				}
 
-				// Reload old manifests
-				try
-				{
-					if (!File.Exists(oldManifestPath))
-					{
-						this.OldManifests.AddOrUpdate(manifestType, null);
-					}
+				this.Manifests.AddOrUpdate(manifestType, LoadManifest(newManifestPath));
 
-					this.OldManifests.AddOrUpdate(manifestType, LoadManifest(oldManifestPath));
-				}
-				catch (IOException ioex)
+				// Reload old manifests
+				if (!File.Exists(oldManifestPath))
 				{
-					Log.Warn($"Could not load old manifest of type {manifestType} (IOException): " + ioex.Message);
+					this.OldManifests.AddOrUpdate(manifestType, null);
 				}
+
+				this.OldManifests.AddOrUpdate(manifestType, LoadManifest(oldManifestPath));
 			}
 		}
 

diff --git a/Launchpad.Common/Launchpad.Common.csproj b/Launchpad.Common/Launchpad.Common.csproj
@@ -30,6 +30,5 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta004" PrivateAssets="all" />
-    <PackageReference Include="log4net" Version="2.0.8" />
   </ItemGroup>
 </Project>
diff --git a/Launchpad.Launcher/Handlers/ChecksHandler.cs b/Launchpad.Launcher/Handlers/ChecksHandler.cs
@@ -26,7 +26,7 @@
 using Launchpad.Launcher.Handlers.Protocols;
 
 using Launchpad.Launcher.Utility;
-using log4net;
+using NLog;
 
 namespace Launchpad.Launcher.Handlers
 {
@@ -38,7 +38,7 @@ internal sealed class ChecksHandler
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(ChecksHandler));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		private readonly PatchProtocolHandler Patch;
 

diff --git a/Launchpad.Launcher/Handlers/GameHandler.cs b/Launchpad.Launcher/Handlers/GameHandler.cs
@@ -30,7 +30,7 @@
 using Launchpad.Launcher.Handlers.Protocols;
 using Launchpad.Launcher.Services;
 using Launchpad.Launcher.Utility;
-using log4net;
+using NLog;
 
 namespace Launchpad.Launcher.Handlers
 {
@@ -50,7 +50,7 @@ internal sealed class GameHandler
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(GameHandler));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		/// <summary>
 		/// Event raised whenever the progress of installing or updating the game changes.

diff --git a/Launchpad.Launcher/Handlers/LauncherHandler.cs b/Launchpad.Launcher/Handlers/LauncherHandler.cs
@@ -31,7 +31,7 @@
 using Launchpad.Launcher.Configuration;
 using Launchpad.Launcher.Handlers.Protocols;
 using Launchpad.Launcher.Utility;
-using log4net;
+using NLog;
 
 namespace Launchpad.Launcher.Handlers
 {
@@ -51,7 +51,7 @@ internal sealed class LauncherHandler
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(LauncherHandler));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		/// <summary>
 		/// Raised whenever the changelog finishes downloading.

diff --git a/Launchpad.Launcher/Handlers/Protocols/Manifest/FTPProtocolHandler.cs b/Launchpad.Launcher/Handlers/Protocols/Manifest/FTPProtocolHandler.cs
@@ -25,9 +25,8 @@
 using System.Net;
 using System.Text;
 
-using Launchpad.Common;
 using Launchpad.Common.Enums;
-using log4net;
+using NLog;
 using SixLabors.ImageSharp;
 
 namespace Launchpad.Launcher.Handlers.Protocols.Manifest
@@ -43,7 +42,7 @@ internal sealed class FTPProtocolHandler : ManifestBasedProtocolHandler
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(FTPProtocolHandler));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		/// <inheritdoc />
 		public override bool CanPatch()

diff --git a/Launchpad.Launcher/Handlers/Protocols/Manifest/HTTPProtocolHandler.cs b/Launchpad.Launcher/Handlers/Protocols/Manifest/HTTPProtocolHandler.cs
@@ -27,7 +27,7 @@
 
 using Launchpad.Common;
 using Launchpad.Common.Enums;
-using log4net;
+using NLog;
 using SixLabors.ImageSharp;
 using Image = SixLabors.ImageSharp.Image;
 
@@ -42,7 +42,7 @@ internal sealed class HTTPProtocolHandler : ManifestBasedProtocolHandler
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(HTTPProtocolHandler));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		/// <inheritdoc />
 		public override bool CanPatch()

diff --git a/Launchpad.Launcher/Handlers/Protocols/Manifest/ManifestBasedProtocolHandler.cs b/Launchpad.Launcher/Handlers/Protocols/Manifest/ManifestBasedProtocolHandler.cs
@@ -31,8 +31,8 @@
 using Launchpad.Common.Handlers.Manifest;
 using Launchpad.Launcher.Services;
 using Launchpad.Launcher.Utility;
-using log4net;
 using NGettext;
+using NLog;
 
 namespace Launchpad.Launcher.Handlers.Protocols.Manifest
 {
@@ -42,14 +42,14 @@ namespace Launchpad.Launcher.Handlers.Protocols.Manifest
 	public abstract class ManifestBasedProtocolHandler : PatchProtocolHandler
 	{
 		/// <summary>
-		/// The localization catalog.
+		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ICatalog LocalizationCatalog = new Catalog("Launchpad", "./Content/locale");
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		/// <summary>
-		/// Logger instance for this class.
+		/// The localization catalog.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(ManifestBasedProtocolHandler));
+		private static readonly ICatalog LocalizationCatalog = new Catalog("Launchpad", "./Content/locale");
 
 		private readonly LocalVersionService LocalVersionService = new LocalVersionService();
 

diff --git a/Launchpad.Launcher/Handlers/Protocols/PatchProtocolHandler.cs b/Launchpad.Launcher/Handlers/Protocols/PatchProtocolHandler.cs
@@ -26,7 +26,7 @@
 using Launchpad.Common.Enums;
 using Launchpad.Launcher.Configuration;
 using Launchpad.Launcher.Services;
-using log4net;
+using NLog;
 using SixLabors.ImageSharp;
 
 namespace Launchpad.Launcher.Handlers.Protocols
@@ -46,7 +46,7 @@ public abstract class PatchProtocolHandler
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(PatchProtocolHandler));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		/// <summary>
 		/// Gets the config handler reference.

diff --git a/Launchpad.Launcher/Interface/MainWindow.cs b/Launchpad.Launcher/Interface/MainWindow.cs
@@ -34,9 +34,9 @@
 using Launchpad.Launcher.Services;
 using Launchpad.Launcher.Utility;
 using Launchpad.Launcher.Utility.Enums;
-using log4net;
 
 using NGettext;
+using NLog;
 using SixLabors.ImageSharp;
 using Application = Gtk.Application;
 using Process = System.Diagnostics.Process;
@@ -53,7 +53,7 @@ public sealed partial class MainWindow : Gtk.Window
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(MainWindow));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		private readonly LocalVersionService LocalVersionService = new LocalVersionService();
 

diff --git a/Launchpad.Launcher/Launchpad.Launcher.csproj b/Launchpad.Launcher/Launchpad.Launcher.csproj
@@ -30,25 +30,22 @@
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <Prefer32bit>true</Prefer32bit>
   </PropertyGroup>
-  <ItemGroup>
-    <Reference Include="System.Runtime.InteropServices.RuntimeInformation" />
-  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Config.Net" Version="4.7.0.89" />
     <PackageReference Include="GtkSharp" Version="3.22.24.29" />
     <PackageReference Include="GtkSharp.Win32" Version="3.1.2" />
+    <PackageReference Include="NLog" Version="4.4.12" />
     <PackageReference Include="SixLabors.ImageSharp" Version="1.0.0-beta0002" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta004" PrivateAssets="all" />
     <PackageReference Include="NGettext" Version="0.6.3" />
-    <PackageReference Include="log4net" Version="2.0.8" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="app.manifest" />
     <EmbeddedResource Include="Resources\**\*.*" />
     <EmbeddedResource Include="Interface\Launchpad.glade" />
   </ItemGroup>
   <ItemGroup>
-    <Content Include="log4net.config">
+    <Content Include="*.config">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
     <Content Include="Content\locale\**\*.po">

diff --git a/Launchpad.Launcher/NLog.config b/Launchpad.Launcher/NLog.config
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- XSD manual extracted from package NLog.Schema: https://www.nuget.org/packages/NLog.Schema-->
+<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xsi:schemaLocation="NLog NLog.xsd"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      autoReload="true"
+      internalLogFile="launchpad-internal.log"
+      internalLogLevel="Info" >
+
+    <!-- the targets to write to -->
+    <targets>
+        <!-- write logs to file -->
+        <target xsi:type="File" name="target1" fileName="launchpad.log"
+                layout="${date} | ${logger:shortName=True} | ${level:uppercase=true} | ${message} ${exception}|${all-event-properties}" />
+        <target xsi:type="ColoredConsole" name="target2"
+                layout="${date} | ${logger:shortName=True} | ${level:uppercase=true} | ${message} ${exception}|${all-event-properties}" />
+    </targets>
+
+    <!-- rules to map from logger name to target -->
+    <rules>
+        <logger name="*" minlevel="Trace" writeTo="target1,target2" />
+    </rules>
+</nlog>
diff --git a/Launchpad.Launcher/Program.cs b/Launchpad.Launcher/Program.cs
@@ -31,8 +31,7 @@
 using Launchpad.Launcher.Interface;
 using Launchpad.Launcher.Services;
 using Launchpad.Launcher.Utility;
-using log4net;
-using FileInfo = System.IO.FileInfo;
+using NLog;
 using Task = System.Threading.Tasks.Task;
 using Timeout = GLib.Timeout;
 
@@ -46,7 +45,7 @@ public static class Program
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(Program));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		private static readonly LocalVersionService LocalVersionService = new LocalVersionService();
 
@@ -66,11 +65,6 @@ private static void Main()
 				Environment.SetEnvironmentVariable("GSETTINGS_SCHEMA_DIR", "share\\glib-2.0\\schemas\\");
 			}
 
-			var logRepo = LogManager.GetRepository(Assembly.GetEntryAssembly());
-			var fileInfo = new FileInfo("log4net.config");
-			log4net.Config.XmlConfigurator.Configure(logRepo, fileInfo);
-
-			Log.Info("----------------");
 			Log.Info($"Launchpad v{LocalVersionService.GetLocalLauncherVersion()} starting...");
 
 			var systemBitness = Environment.Is64BitOperatingSystem ? "x64" : "x86";

diff --git a/Launchpad.Launcher/Services/LocalVersionService.cs b/Launchpad.Launcher/Services/LocalVersionService.cs
@@ -24,7 +24,7 @@
 using System.IO;
 
 using Launchpad.Launcher.Utility;
-using log4net;
+using NLog;
 
 namespace Launchpad.Launcher.Services
 {
@@ -36,7 +36,7 @@ public class LocalVersionService
 		/// <summary>
 		/// Logger instance for this class.
 		/// </summary>
-		private static readonly ILog Log = LogManager.GetLogger(typeof(LocalVersionService));
+		private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
 
 		/// <summary>
 		/// Gets the local game version.

diff --git a/Launchpad.Launcher/log4net.config b/Launchpad.Launcher/log4net.config
diff --git a/Launchpad.Utilities/Launchpad.Utilities.csproj b/Launchpad.Utilities/Launchpad.Utilities.csproj
@@ -30,7 +30,7 @@
     <PackageReference Include="GtkSharp.Win32" Version="3.1.2" />
     <PackageReference Include="CommandLineParser" Version="2.2.1" />
     <PackageReference Include="NGettext" Version="0.6.3" />
-    <PackageReference Include="log4net" Version="2.0.8" />
+    <PackageReference Include="NLog" Version="4.4.12" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="Interface\Launchpad.Utilities.glade" />