Merge branch 'dev/v3.17.x.x'

witcher112 · witcher112 · commit 2f4cfa30c5e0 · 2020-09-03T14:08:10.000+02:00
diff --git a/Assets/PatchKit Patcher/Scripts/AppData/Local/Pack1Meta.cs b/Assets/PatchKit Patcher/Scripts/AppData/Local/Pack1Meta.cs
@@ -1,10 +1,13 @@
 ﻿using System.IO;
 using Newtonsoft.Json;
+using PatchKit.Unity.Patcher.Debug;
 
 namespace PatchKit.Unity.Patcher.AppData.Local
 {
     public class Pack1Meta
     {
+        private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(Pack1Meta));
+
         #region Fields
 
         public string Version { get; set; }
@@ -30,7 +33,7 @@ public static Pack1Meta ParseFromFile(string filename)
 
         public static Pack1Meta Parse(string content)
         {
-            UnityEngine.Debug.Log(content);
+            DebugLogger.Log(content);
             return JsonConvert.DeserializeObject<Pack1Meta>(content);
         }
 
diff --git a/Assets/PatchKit Patcher/Scripts/AppData/Local/ThreadBufferedStream.cs b/Assets/PatchKit Patcher/Scripts/AppData/Local/ThreadBufferedStream.cs
@@ -2,11 +2,14 @@
 using System.IO;
 using System.Threading;
 using JetBrains.Annotations;
+using PatchKit.Unity.Patcher.Debug;
 
 namespace PatchKit.Unity.Patcher.AppData.Local
 {
     public class ThreadBufferedStream : Stream
     {
+        private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(ThreadBufferedStream));
+
         private readonly Stream _innerStream;
         private readonly byte[] _buffer;
 
@@ -68,12 +71,12 @@ private void SpawnReaderThread()
                 {
                     try
                     {
-                        //UnityEngine.Debug.Log("Entering semaphore from thread...");
+                        //DebugLogger.Log("Entering semaphore from thread...");
                         _semaphore.WaitOne();
                         {
                             if (_eof)
                             {
-                                //UnityEngine.Debug.Log("BREAKING semaphore from thread...");
+                                //DebugLogger.Log("BREAKING semaphore from thread...");
                                 break;
                             }
 
@@ -85,7 +88,7 @@ private void SpawnReaderThread()
                     }
                     finally
                     {
-                        //UnityEngine.Debug.Log("Leaving semaphore from thread.");
+                        //DebugLogger.Log("Leaving semaphore from thread.");
                         _semaphore.Release();
                     }
 
@@ -100,7 +103,7 @@ public override int Read(byte[] buffer, int offset, int count)
 
             try
             {
-                //UnityEngine.Debug.Log("Entering semaphore from Read..." + count);
+                //DebugLogger.Log("Entering semaphore from Read..." + count);
                 _semaphore.WaitOne();
                 {
                     // repeat while there's something to read
@@ -131,36 +134,36 @@ public override int Read(byte[] buffer, int offset, int count)
                         if (copied == count)
                         {
                             // all bytes has been copied
-                            //UnityEngine.Debug.Log("BREAK semaphore from Read.");
+                            //DebugLogger.Log("BREAK semaphore from Read.");
                             break;
                         }
                     }
                 }
             }
             finally
             {
-                //UnityEngine.Debug.Log("Leaving semaphore from Read.");
+                //DebugLogger.Log("Leaving semaphore from Read.");
                 _semaphore.Release();
             }
 
             _position += copied;
 
-            //UnityEngine.Debug.Log("Returning " + copied);
+            //DebugLogger.Log("Returning " + copied);
 
             return copied;
         }
 
         private void ReadToBuffer()
         {
             int size = _buffer.Length - _bufferedBytes;
-            //UnityEngine.Debug.Log("Reading into buffer " + size);
+            //DebugLogger.Log("Reading into buffer " + size);
 
             int read = _innerStream.Read(_buffer, _bufferedBytes, size);
             _bufferedBytes += read;
 
             if (read == 0)
             {
-                //UnityEngine.Debug.Log("End of file");
+                //DebugLogger.Debug.Log("End of file");
                 _eof = true;
             }
         }
diff --git a/Assets/PatchKit Patcher/Scripts/Debug/UnityMessageWriter.cs b/Assets/PatchKit Patcher/Scripts/Debug/UnityMessageWriter.cs
@@ -19,6 +19,11 @@ public UnityMessageWriter([NotNull] IMessageFormatter formatter)
         public void Write(Message message, MessageContext messageContext)
         {
             var text = _formatter.Format(message, messageContext);
+            var patcher = Patcher.Instance;
+            if (!string.IsNullOrEmpty(patcher.AppSecret))
+            {
+                text = text.Replace(patcher.AppSecret, patcher.TraceableAppSecret);
+            }
 
             switch (message.Type)
             {
diff --git a/Assets/PatchKit Patcher/Scripts/Patcher.cs b/Assets/PatchKit Patcher/Scripts/Patcher.cs
@@ -87,6 +87,23 @@ public static Patcher Instance
 
         private PatchKit.Unity.Patcher.Cancellation.CancellationTokenSource _updateAppCancellationTokenSource;
 
+        public string TraceableAppSecret     
+        {
+            get
+            {
+                if (_traceableAppSecret == null)
+                {
+                    _traceableAppSecret = BuildTraceableAppSecret();
+                }
+
+                return _traceableAppSecret;
+            }
+        }
+
+        private string _traceableAppSecret;
+        
+        public string AppSecret { get; private set; }
+        
         public ErrorDialog ErrorDialog;
 
         public string EditorAppSecret;
@@ -512,6 +529,8 @@ private void ThreadLoadPatcherData()
                 var inputArgumentsPatcherDataReader = new InputArgumentsPatcherDataReader();
                 _data.Value = inputArgumentsPatcherDataReader.Read();
 #endif
+                AppSecret = _data.Value.AppSecret;
+
                 DebugLogger.LogVariable(_data.Value.AppSecret, "Data.AppSecret");
                 DebugLogger.LogVariable(_data.Value.AppDataPath, "Data.AppDataPath");
                 DebugLogger.LogVariable(_data.Value.OverrideLatestVersionId, "Data.OverrideLatestVersionId");
@@ -953,5 +972,11 @@ private bool ThreadTryRestartWithRequestForPermissions()
                 return false;
             }
         }
+        
+        private string BuildTraceableAppSecret()
+        {
+            return string.Format("{0}...{1}", AppSecret.Substring(0, 6),
+                AppSecret.Substring(AppSecret.Length - 6));
+        }
     }
 }
diff --git a/Assets/PatchKit Patcher/Scripts/PatcherSenderId.cs b/Assets/PatchKit Patcher/Scripts/PatcherSenderId.cs
@@ -3,12 +3,15 @@
 using PatchKit.Unity.Patcher.AppData;
 using PatchKit.Unity.Patcher.AppData.FileSystem;
 using PatchKit.Unity.Patcher.Cancellation;
+using PatchKit.Unity.Patcher.Debug;
 using PatchKit.Unity.Utilities;
 
 namespace PatchKit.Unity.Patcher
 {
     public class PatcherSenderId
     {
+        private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(PatcherSenderId));
+
         private static string _senderId;
 
         public static string Get()
@@ -25,7 +28,7 @@ private static string GenerateOrRead()
                 string savedSenderId = File.ReadAllText(filePath);
                 if (!string.IsNullOrEmpty(savedSenderId))
                 {
-                    UnityEngine.Debug.Log("SenderId: " + savedSenderId + " (loaded from " + filePath + ")");
+                    DebugLogger.Log("SenderId: " + savedSenderId + " (loaded from " + filePath + ")");
 
                     return savedSenderId;
                 }
@@ -41,7 +44,7 @@ private static string GenerateOrRead()
 
             File.WriteAllText(filePath, senderId);
 
-            UnityEngine.Debug.Log("SenderId: " + senderId + " (saved in " + filePath + ")");
+            DebugLogger.Log("SenderId: " + senderId + " (saved in " + filePath + ")");
 
             return senderId;
         }
diff --git a/Assets/PatchKit Patcher/Scripts/PatcherStatistics.cs b/Assets/PatchKit Patcher/Scripts/PatcherStatistics.cs
@@ -17,6 +17,8 @@ namespace PatchKit.Unity.Patcher
 {
     public class PatcherStatistics
     {
+        private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(PatcherStatistics));
+        
         public enum Event
         {
             [Description("content_download_started")]
@@ -201,7 +203,7 @@ public static IEnumerator SendEvent(Event ev, string appSecret, OptionalParams?
             request.downloadHandler = new DownloadHandlerBuffer();
             request.SetRequestHeader("Content-Type", "application/json");
 
-            UnityEngine.Debug.Log("Sending event:\n" + json.ToString(Formatting.Indented));
+            DebugLogger.Log("Sending event:\n" + json.ToString(Formatting.Indented));
 
             yield return request.Send();
 
@@ -211,11 +213,11 @@ public static IEnumerator SendEvent(Event ev, string appSecret, OptionalParams?
             if (request.isError || request.responseCode != 201)
 #endif
             {
-                UnityEngine.Debug.LogError("Failed to send event " + eventName + " (" + request.responseCode + "):\n" + request.error);
+                DebugLogger.LogError("Failed to send event " + eventName + " (" + request.responseCode + "):\n" + request.error);
             }
             else
             {
-                UnityEngine.Debug.Log("Event " + eventName + " has been sent!");
+                DebugLogger.Log("Event " + eventName + " has been sent!");
             }
         }
     }
diff --git a/Assets/PatchKit Patcher/Scripts/UI/Changelog/ChangelogList.cs b/Assets/PatchKit Patcher/Scripts/UI/Changelog/ChangelogList.cs
@@ -5,13 +5,16 @@
 using PatchKit.Api.Models.Main;
 using PatchKit.Unity.Patcher.AppData.Local;
 using PatchKit.Unity.Patcher.Cancellation;
+using PatchKit.Unity.Patcher.Debug;
 using PatchKit.Unity.UI;
 using PatchKit.Unity.Utilities;
 
 namespace PatchKit.Unity.Patcher.UI
 {
     public class ChangelogList : UIApiComponent
     {
+        private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(ChangelogList));
+
         public ChangelogElement TitlePrefab;
 
         public ChangelogElement ChangePrefab;
@@ -67,7 +70,7 @@ private void CreateAndCacheChangelog(string appSecret, AppVersion[] versions)
             }
             catch (Exception e)
             {
-                UnityEngine.Debug.Log(e.ToString());
+                DebugLogger.Log(e.ToString());
             }
 
             CreateChangelog(versions);
diff --git a/Assets/PatchKit Patcher/Scripts/Version.cs b/Assets/PatchKit Patcher/Scripts/Version.cs
@@ -4,7 +4,7 @@ public static class Version
     {
         public const int Major = 3;
         public const int Minor = 17;
-        public const int Patch = 2;
+        public const int Patch = 3;
         public const int Hotfix = 0;
 
         public static string Value
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.17.3.0]
+### Added
+- Filtering the secret in the patcher logs (#2040)
+
 ## [3.17.2.0]
 ### Added
 - Attempting to repair content on failed installation

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,13 @@`
`1`	`1`	`using System.IO;`
`2`	`2`	`using Newtonsoft.Json;`
	`3`	`+using PatchKit.Unity.Patcher.Debug;`
`3`	`4`
`4`	`5`	`namespace PatchKit.Unity.Patcher.AppData.Local`
`5`	`6`	`{`
`6`	`7`	`public class Pack1Meta`
`7`	`8`	`{`
	`9`	`+ private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(Pack1Meta));`
	`10`	`+`
`8`	`11`	`#region Fields`
`9`	`12`
`10`	`13`	`public string Version { get; set; }`
`@@ -30,7 +33,7 @@ public static Pack1Meta ParseFromFile(string filename)`
`30`	`33`
`31`	`34`	`public static Pack1Meta Parse(string content)`
`32`	`35`	`{`
`33`		`- UnityEngine.Debug.Log(content);`
	`36`	`+ DebugLogger.Log(content);`
`34`	`37`	`return JsonConvert.DeserializeObject<Pack1Meta>(content);`
`35`	`38`	`}`
`36`	`39`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,14 @@`
`2`	`2`	`using System.IO;`
`3`	`3`	`using System.Threading;`
`4`	`4`	`using JetBrains.Annotations;`
	`5`	`+using PatchKit.Unity.Patcher.Debug;`
`5`	`6`
`6`	`7`	`namespace PatchKit.Unity.Patcher.AppData.Local`
`7`	`8`	`{`
`8`	`9`	`public class ThreadBufferedStream : Stream`
`9`	`10`	`{`
	`11`	`+ private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(ThreadBufferedStream));`
	`12`	`+`
`10`	`13`	`private readonly Stream _innerStream;`
`11`	`14`	`private readonly byte[] _buffer;`
`12`	`15`
`@@ -68,12 +71,12 @@ private void SpawnReaderThread()`
`68`	`71`	`{`
`69`	`72`	`try`
`70`	`73`	`{`
`71`		`- //UnityEngine.Debug.Log("Entering semaphore from thread...");`
	`74`	`+ //DebugLogger.Log("Entering semaphore from thread...");`
`72`	`75`	`_semaphore.WaitOne();`
`73`	`76`	`{`
`74`	`77`	`if (_eof)`
`75`	`78`	`{`
`76`		`- //UnityEngine.Debug.Log("BREAKING semaphore from thread...");`
	`79`	`+ //DebugLogger.Log("BREAKING semaphore from thread...");`
`77`	`80`	`break;`
`78`	`81`	`}`
`79`	`82`
`@@ -85,7 +88,7 @@ private void SpawnReaderThread()`
`85`	`88`	`}`
`86`	`89`	`finally`
`87`	`90`	`{`
`88`		`- //UnityEngine.Debug.Log("Leaving semaphore from thread.");`
	`91`	`+ //DebugLogger.Log("Leaving semaphore from thread.");`
`89`	`92`	`_semaphore.Release();`
`90`	`93`	`}`
`91`	`94`
`@@ -100,7 +103,7 @@ public override int Read(byte[] buffer, int offset, int count)`
`100`	`103`
`101`	`104`	`try`
`102`	`105`	`{`
`103`		`- //UnityEngine.Debug.Log("Entering semaphore from Read..." + count);`
	`106`	`+ //DebugLogger.Log("Entering semaphore from Read..." + count);`
`104`	`107`	`_semaphore.WaitOne();`
`105`	`108`	`{`
`106`	`109`	`// repeat while there's something to read`
`@@ -131,36 +134,36 @@ public override int Read(byte[] buffer, int offset, int count)`
`131`	`134`	`if (copied == count)`
`132`	`135`	`{`
`133`	`136`	`// all bytes has been copied`
`134`		`- //UnityEngine.Debug.Log("BREAK semaphore from Read.");`
	`137`	`+ //DebugLogger.Log("BREAK semaphore from Read.");`
`135`	`138`	`break;`
`136`	`139`	`}`
`137`	`140`	`}`
`138`	`141`	`}`
`139`	`142`	`}`
`140`	`143`	`finally`
`141`	`144`	`{`
`142`		`- //UnityEngine.Debug.Log("Leaving semaphore from Read.");`
	`145`	`+ //DebugLogger.Log("Leaving semaphore from Read.");`
`143`	`146`	`_semaphore.Release();`
`144`	`147`	`}`
`145`	`148`
`146`	`149`	`_position += copied;`
`147`	`150`
`148`		`- //UnityEngine.Debug.Log("Returning " + copied);`
	`151`	`+ //DebugLogger.Log("Returning " + copied);`
`149`	`152`
`150`	`153`	`return copied;`
`151`	`154`	`}`
`152`	`155`
`153`	`156`	`private void ReadToBuffer()`
`154`	`157`	`{`
`155`	`158`	`int size = _buffer.Length - _bufferedBytes;`
`156`		`- //UnityEngine.Debug.Log("Reading into buffer " + size);`
	`159`	`+ //DebugLogger.Log("Reading into buffer " + size);`
`157`	`160`
`158`	`161`	`int read = _innerStream.Read(_buffer, _bufferedBytes, size);`
`159`	`162`	`_bufferedBytes += read;`
`160`	`163`
`161`	`164`	`if (read == 0)`
`162`	`165`	`{`
`163`		`- //UnityEngine.Debug.Log("End of file");`
	`166`	`+ //DebugLogger.Debug.Log("End of file");`
`164`	`167`	`_eof = true;`
`165`	`168`	`}`
`166`	`169`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,11 @@ public UnityMessageWriter([NotNull] IMessageFormatter formatter)`
`19`	`19`	`public void Write(Message message, MessageContext messageContext)`
`20`	`20`	`{`
`21`	`21`	`var text = _formatter.Format(message, messageContext);`
	`22`	`+ var patcher = Patcher.Instance;`
	`23`	`+ if (!string.IsNullOrEmpty(patcher.AppSecret))`
	`24`	`+ {`
	`25`	`+ text = text.Replace(patcher.AppSecret, patcher.TraceableAppSecret);`
	`26`	`+ }`
`22`	`27`
`23`	`28`	`switch (message.Type)`
`24`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,15 @@`
`3`	`3`	`using PatchKit.Unity.Patcher.AppData;`
`4`	`4`	`using PatchKit.Unity.Patcher.AppData.FileSystem;`
`5`	`5`	`using PatchKit.Unity.Patcher.Cancellation;`
	`6`	`+using PatchKit.Unity.Patcher.Debug;`
`6`	`7`	`using PatchKit.Unity.Utilities;`
`7`	`8`
`8`	`9`	`namespace PatchKit.Unity.Patcher`
`9`	`10`	`{`
`10`	`11`	`public class PatcherSenderId`
`11`	`12`	`{`
	`13`	`+ private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(PatcherSenderId));`
	`14`	`+`
`12`	`15`	`private static string _senderId;`
`13`	`16`
`14`	`17`	`public static string Get()`
`@@ -25,7 +28,7 @@ private static string GenerateOrRead()`
`25`	`28`	`string savedSenderId = File.ReadAllText(filePath);`
`26`	`29`	`if (!string.IsNullOrEmpty(savedSenderId))`
`27`	`30`	`{`
`28`		`- UnityEngine.Debug.Log("SenderId: " + savedSenderId + " (loaded from " + filePath + ")");`
	`31`	`+ DebugLogger.Log("SenderId: " + savedSenderId + " (loaded from " + filePath + ")");`
`29`	`32`
`30`	`33`	`return savedSenderId;`
`31`	`34`	`}`
`@@ -41,7 +44,7 @@ private static string GenerateOrRead()`
`41`	`44`
`42`	`45`	`File.WriteAllText(filePath, senderId);`
`43`	`46`
`44`		`- UnityEngine.Debug.Log("SenderId: " + senderId + " (saved in " + filePath + ")");`
	`47`	`+ DebugLogger.Log("SenderId: " + senderId + " (saved in " + filePath + ")");`
`45`	`48`
`46`	`49`	`return senderId;`
`47`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@ namespace PatchKit.Unity.Patcher`
`17`	`17`	`{`
`18`	`18`	`public class PatcherStatistics`
`19`	`19`	`{`
	`20`	`+ private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(PatcherStatistics));`
	`21`	`+`
`20`	`22`	`public enum Event`
`21`	`23`	`{`
`22`	`24`	`[Description("content_download_started")]`
`@@ -201,7 +203,7 @@ public static IEnumerator SendEvent(Event ev, string appSecret, OptionalParams?`
`201`	`203`	`request.downloadHandler = new DownloadHandlerBuffer();`
`202`	`204`	`request.SetRequestHeader("Content-Type", "application/json");`
`203`	`205`
`204`		`- UnityEngine.Debug.Log("Sending event:\n" + json.ToString(Formatting.Indented));`
	`206`	`+ DebugLogger.Log("Sending event:\n" + json.ToString(Formatting.Indented));`
`205`	`207`
`206`	`208`	`yield return request.Send();`
`207`	`209`
`@@ -211,11 +213,11 @@ public static IEnumerator SendEvent(Event ev, string appSecret, OptionalParams?`
`211`	`213`	`if (request.isError \|\| request.responseCode != 201)`
`212`	`214`	`#endif`
`213`	`215`	`{`
`214`		`- UnityEngine.Debug.LogError("Failed to send event " + eventName + " (" + request.responseCode + "):\n" + request.error);`
	`216`	`+ DebugLogger.LogError("Failed to send event " + eventName + " (" + request.responseCode + "):\n" + request.error);`
`215`	`217`	`}`
`216`	`218`	`else`
`217`	`219`	`{`
`218`		`- UnityEngine.Debug.Log("Event " + eventName + " has been sent!");`
	`220`	`+ DebugLogger.Log("Event " + eventName + " has been sent!");`
`219`	`221`	`}`
`220`	`222`	`}`
`221`	`223`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,16 @@`
`5`	`5`	`using PatchKit.Api.Models.Main;`
`6`	`6`	`using PatchKit.Unity.Patcher.AppData.Local;`
`7`	`7`	`using PatchKit.Unity.Patcher.Cancellation;`
	`8`	`+using PatchKit.Unity.Patcher.Debug;`
`8`	`9`	`using PatchKit.Unity.UI;`
`9`	`10`	`using PatchKit.Unity.Utilities;`
`10`	`11`
`11`	`12`	`namespace PatchKit.Unity.Patcher.UI`
`12`	`13`	`{`
`13`	`14`	`public class ChangelogList : UIApiComponent`
`14`	`15`	`{`
	`16`	`+ private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(ChangelogList));`
	`17`	`+`
`15`	`18`	`public ChangelogElement TitlePrefab;`
`16`	`19`
`17`	`20`	`public ChangelogElement ChangePrefab;`
`@@ -67,7 +70,7 @@ private void CreateAndCacheChangelog(string appSecret, AppVersion[] versions)`
`67`	`70`	`}`
`68`	`71`	`catch (Exception e)`
`69`	`72`	`{`
`70`		`- UnityEngine.Debug.Log(e.ToString());`
	`73`	`+ DebugLogger.Log(e.ToString());`
`71`	`74`	`}`
`72`	`75`
`73`	`76`	`CreateChangelog(versions);`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ public static class Version`
`4`	`4`	`{`
`5`	`5`	`public const int Major = 3;`
`6`	`6`	`public const int Minor = 17;`
`7`		`- public const int Patch = 2;`
	`7`	`+ public const int Patch = 3;`
`8`	`8`	`public const int Hotfix = 0;`
`9`	`9`
`10`	`10`	`public static string Value`