PowerToys/src/modules/MouseWithoutBorders/App/Class/Common.Log.cs

// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Reflection;
using System.Text;
using System.Threading;
using System.Windows.Forms;

// <summary>
//     Logging.
// </summary>
// <history>
//     2008 created by Truong Do (ductdo).
//     2009-... modified by Truong Do (TruongDo).
//     2023- Included in PowerToys.
// </history>
using MouseWithoutBorders.Class;
using MouseWithoutBorders.Exceptions;

namespace MouseWithoutBorders
{
    public class Thread
    {
        private static readonly object ThreadsLock = new();
        private static List<System.Threading.Thread> threads;

        private readonly System.Threading.Thread thread;

        internal Thread(ThreadStart callback, string name)
        {
            UpdateThreads(thread = new System.Threading.Thread(callback) { Name = name });
        }

        internal Thread(ParameterizedThreadStart callback, string name)
        {
            UpdateThreads(thread = new System.Threading.Thread(callback) { Name = name });
        }

        internal static void UpdateThreads(System.Threading.Thread thread)
        {
            lock (ThreadsLock)
            {
                bool found = false;
                List<System.Threading.Thread> toBeRemovedThreads = new();
                threads ??= new List<System.Threading.Thread>();

                foreach (System.Threading.Thread t in threads)
                {
                    if (!t.IsAlive)
                    {
                        toBeRemovedThreads.Add(t);
                    }
                    else if (t.ManagedThreadId == thread.ManagedThreadId)
                    {
                        found = true;
                    }
                }

                foreach (System.Threading.Thread t in toBeRemovedThreads)
                {
                    _ = threads.Remove(t);
                }

                if (!found)
                {
                    threads.Add(thread);
                }
            }
        }

        internal static string DumpThreadsStack()
        {
            string stack = "\r\nMANAGED THREADS: " + threads.Count.ToString(CultureInfo.InvariantCulture) + "\r\n";
            stack += Common.GetStackTrace(new StackTrace());
            return stack;
        }

        internal static void SuspendAllThreadsBut(int threadId)
        {
            lock (ThreadsLock)
            {
#pragma warning disable 618 // Temporary
                threads.Where(t => t.IsAlive && t.ManagedThreadId != threadId).ToList().ForEach(t => t.Suspend());
#pragma warning restore 618
            }
        }

        internal void SetApartmentState(ApartmentState apartmentState)
        {
            thread.SetApartmentState(apartmentState);
        }

        internal void Start()
        {
            thread.Start();
        }

        internal void Start(object parameter)
        {
            thread.Start(parameter);
        }

        internal static void Sleep(int millisecondsTimeout)
        {
            System.Threading.Thread.Sleep(millisecondsTimeout);
        }

        internal static System.Threading.Thread CurrentThread => System.Threading.Thread.CurrentThread;

        internal ThreadPriority Priority
        {
            get => thread.Priority;
            set => thread.Priority = value;
        }

        internal System.Threading.ThreadState ThreadState => thread.ThreadState;
    }

    internal partial class Common
    {
        private static readonly string[] AllLogs = new string[MAX_LOG];
        private static readonly object AllLogsLock = new();
        private static readonly ConcurrentDictionary<string, int> LogCounter = new();
        private static readonly int[] RepeatedLogIndexSelection = new[] { 1, 3, 10, 50, 100 };
        private const int MAX_LOG = 10000;
        private static int allLogsIndex;

        private const int MaxLogExceptionPerHour = 1000;
        private static int lastHour;
        private static int exceptionCount;

        internal static void TelemetryLogTrace(string log, SeverityLevel severityLevel, bool flush = false)
        {
            int logCount = LogCounter.AddOrUpdate(log, 1, (key, value) => value + 1);
            Common.Log(log);
        }

        internal static void Log(Exception e)
        {
            if (e is not KnownException)
            {
                string exText = e.ToString();

                Log($"!Exception!: {exText}");

                if (DateTime.UtcNow.Hour != lastHour)
                {
                    lastHour = DateTime.UtcNow.Hour;
                    exceptionCount = 0;
                }

                if (exceptionCount < MaxLogExceptionPerHour)
                {
                    exceptionCount++;
                }
                else if (exceptionCount != short.MaxValue)
                {
                    exceptionCount = short.MaxValue;
                }
            }
        }

        private const string HeaderSENT =
            "Be{0},Ke{1},Mo{2},He{3},Mx{4},Tx{5},Im{6},By{7},Cl{8},Dr{9},De{10},Ed{11},Ie{12},Ni{13}";

        private const string HeaderRECEIVED =
            "Be{0},Ke{1},Mo{2},He{3},Mx{4},Tx{5},Im{6},By{7},Cl{8},Dr{9},De{10},Ed{11},In{12},Ni{13},Pc{14}/{15}";

        internal static void LogDebug(string log, bool clearLog = false)
        {
#if DEBUG
            Log(log, clearLog);
#endif
        }

        internal static void Log(string log, bool clearLog = false)
        {
            log = DateTime.Now.ToString("MM/dd HH:mm:ss.fff", CultureInfo.InvariantCulture) + $"({Thread.CurrentThread.ManagedThreadId})" + log;

            ManagedCommon.Logger.LogInfo(log);
            lock (AllLogsLock)
            {
                if (clearLog)
                {
                    allLogsIndex = 0;
                }

                AllLogs[allLogsIndex] = log;
                allLogsIndex = (allLogsIndex + 1) % MAX_LOG;
            }
        }

        internal static void LogDebug(string format, params object[] args)
        {
#if DEBUG
            Log(format, args);
#endif
        }

        internal static void Log(string format, params object[] args)
        {
            Common.Log(string.Format(CultureInfo.InvariantCulture, format, args));
        }

        private static PackageMonitor p1;
        private static PackageMonitor p2;

        [Conditional("DEBUG")]
        internal static void LogAll()
        {
            string log;

            if (!p1.Equals(PackageSent))
            {
                log = string.Format(
                    CultureInfo.CurrentCulture,
                    "SENT:" + HeaderSENT,
                    PackageSent.Heartbeat,
                    PackageSent.Keyboard,
                    PackageSent.Mouse,
                    PackageSent.Hello,
                    PackageSent.Matrix,
                    PackageSent.ClipboardText,
                    PackageSent.ClipboardImage,
                    PackageSent.ByeBye,
                    PackageSent.Clipboard,
                    PackageSent.ClipboardDragDrop,
                    PackageSent.ClipboardDragDropEnd,
                    PackageSent.ExplorerDragDrop,
                    inputEventCount,
                    PackageSent.Nil);
                Log(log);
                p1 = PackageSent; // Copy data
            }

            if (!p2.Equals(PackageReceived))
            {
                log = string.Format(
                    CultureInfo.CurrentCulture,
                    "RECEIVED:" + HeaderRECEIVED,
                    PackageReceived.Heartbeat,
                    PackageReceived.Keyboard,
                    PackageReceived.Mouse,
                    PackageReceived.Hello,
                    PackageReceived.Matrix,
                    PackageReceived.ClipboardText,
                    PackageReceived.ClipboardImage,
                    PackageReceived.ByeBye,
                    PackageReceived.Clipboard,
                    PackageReceived.ClipboardDragDrop,
                    PackageReceived.ClipboardDragDropEnd,
                    PackageReceived.ExplorerDragDrop,
                    invalidPackageCount,
                    PackageReceived.Nil,
                    processedPackageCount,
                    skippedPackageCount);
                Log(log);
                p2 = PackageReceived;
            }
        }

        internal static void GenerateLog()
        {
            int l = Setting.Values.DumpObjectsLevel;
            if (l is > 0 and < 10)
            {
                Common.DumpObjects(l);
            }
        }

        private static List<ProcessThread> myThreads;

        internal static void DumpObjects(int level)
        {
            try
            {
                string logFile = Path.Combine(Common.RunWithNoAdminRight ? Path.GetTempPath() : Path.GetDirectoryName(Application.ExecutablePath), "MagicMouse.log");

                StringBuilder sb = new(1000000);
                string log;

                myThreads = new List<ProcessThread>();

                foreach (ProcessThread t in Process.GetCurrentProcess().Threads)
                {
                    myThreads.Add(t);
                }

                _ = PrivateDump(sb, AllLogs, "[Program logs]\r\n===============\r\n", 0, level, false);
                _ = PrivateDump(sb, new Common(), "[Other Logs]\r\n===============\r\n", 0, level, false);

                log = string.Format(
                    CultureInfo.CurrentCulture,
                    "{0} {1}\r\n{2}\r\n\r\n{3}",
                    Application.ProductName,
                    Application.ProductVersion,
                    "Private Mem: " + (Process.GetCurrentProcess().PrivateMemorySize64 / 1024).ToString(CultureInfo.CurrentCulture) + "KB",
                    sb.ToString());

                if (!string.IsNullOrEmpty(myKey))
                {
                    log = log.Replace(MyKey, GetDebugInfo(MyKey));
                }

                log += Thread.DumpThreadsStack();
                log += $"\r\nCurrent process session: {Process.GetCurrentProcess().SessionId}, active console session: {NativeMethods.WTSGetActiveConsoleSessionId()}.";

                File.WriteAllText(logFile, log);

                if (RunOnLogonDesktop || RunOnScrSaverDesktop)
                {
                    _ = MessageBox.Show("Dump file created: " + logFile, Application.ProductName);
                }
                else
                {
                    ShowToolTip("Dump file created: " + logFile + " and placed in the Clipboard.", 10000);
                    Clipboard.SetText(logFile);
                }
            }
            catch (Exception e)
            {
                _ = MessageBox.Show(e.Message + "\r\n" + e.StackTrace, Application.ProductName);
            }
        }

        private static object GetFieldValue(object obj, string fieldName)
        {
            FieldInfo fi;
            Type t;

            t = obj.GetType();
            fi = t.GetField(fieldName, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static);
            return fi?.GetValue(obj);
        }

        private static bool PrivateDump(StringBuilder sb, object obj, string objName, int level, int maxLevel, bool stop)
        {
            Type t;
            string padStr = string.Empty;
            string[] strArr;
            string objString;

            if (obj == null || (maxLevel >= 0 && level >= maxLevel) || obj is Cursor)
            {
                return false;
            }

            for (int i = 0; i < level; i++)
            {
                padStr += i < level - 1 ? "-" : padStr += string.Empty;
            }

            objString = obj.ToString();
            t = obj.GetType();
            strArr = new string[7];
            strArr[0] = padStr;
            strArr[1] = objName;

            // strArr[2] = " ";
            // strArr[3] = t.FullName;
            strArr[4] = " = ";
            strArr[5] = objName.Equals("myKey", StringComparison.OrdinalIgnoreCase) ? GetDebugInfo(objString)
                : objName.Equals("lastClipboardObject", StringComparison.OrdinalIgnoreCase) ? string.Empty
                : objString.Replace("System.Windows.Forms.", string.Empty).Replace("System.Net.Sockets.", string.Empty).Replace("System.Security.Cryptography.", string.Empty).Replace("System.Threading.", string.Empty)
                .Replace("System.ComponentModel.", string.Empty).Replace("System.Runtime.", string.Empty).Replace("System.Drawing.", string.Empty).Replace("System.Object", "O").Replace("System.Diagnostics.", string.Empty)
                .Replace("System.Collections.", string.Empty).Replace("System.Drawing.", string.Empty).Replace("System.Int", string.Empty).Replace("System.EventHandler.", string.Empty);
            strArr[6] = "\r\n";
            _ = sb.Append(string.Concat(strArr).Replace(Common.BinaryName, "MM"));

            if (stop || t.IsPrimitive)
            {
                return false;
            }

            DumpType(padStr, sb, obj, level, t, maxLevel);
            return true;
        }

        private static void DumpType(string initialStr, StringBuilder sb, object obj, int level, System.Type t, int maxLevel)
        {
            int i;
            bool stop;
            if (t == typeof(System.Delegate))
            {
                return;
            }

            FieldInfo[] fi;
            string type;

            if (obj is MouseWithoutBorders.PackageType or string or AddressFamily or ID or IPAddress
                )
            {
                return;
            }

            type = obj.GetType().ToString();

            if (type.EndsWith("type", StringComparison.CurrentCultureIgnoreCase) || type.Contains("Cryptography")
                || type.EndsWith("AsyncEventBits", StringComparison.CurrentCultureIgnoreCase))
            {
                return;
            }

            stop = obj == null || obj is MouseWithoutBorders.DATA || obj.GetType().BaseType == typeof(ValueType)
                || obj.GetType().Namespace.Contains("System.Windows");
            fi = t.GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static);

            foreach (FieldInfo f in fi)
            {
                if (f.GetValue(obj) != AllLogs)
                {
                    _ = PrivateDump(sb, f.GetValue(obj), f.Name, level + 1, maxLevel, stop);
                }
            }

            if (obj is Dictionary<string, List<IPAddress>>)
            {
                Dictionary<string, List<IPAddress>> d = obj as Dictionary<string, List<IPAddress>>;

                foreach (string k in d.Keys)
                {
                    if (d.TryGetValue(k, out List<IPAddress> l))
                    {
                        foreach (IPAddress ip in l)
                        {
                            _ = PrivateDump(sb, ip, "[" + k + "]", level + 1, maxLevel, false);
                        }
                    }
                }
            }

            if (obj is System.Array)
            {
                try
                {
                    if (obj is MachineInf[])
                    {
                        MachineInf[] os = (MachineInf[])obj;

                        for (i = 0; i < os.GetLength(0); i++)
                        {
                            _ = PrivateDump(sb, os[i], "[" + i + "]", level + 1, maxLevel, false);
                        }
                    }
                    else if (obj is int[] || obj is uint[])
                    {
                        int[] os = (int[])obj;

                        for (i = 0; i < os.GetLength(0); i++)
                        {
                            _ = PrivateDump(sb, os[i], "[" + i + "]", level + 1, maxLevel, false);
                        }
                    }
                    else if (obj is short[] || obj is ushort[])
                    {
                        short[] os = (short[])obj;

                        for (i = 0; i < os.GetLength(0); i++)
                        {
                            _ = PrivateDump(sb, os[i], "[" + i + "]", level + 1, maxLevel, false);
                        }
                    }
                    else if (obj is TcpClient[] || obj is IPAddress[] || obj is TcpSk[] || obj is string[]
                        || obj is TcpServer[]
                        || obj is ProcessThread[] || obj is Thread[])
                    {
                        object[] os = (object[])obj;

                        for (i = 0; i < os.GetLength(0); i++)
                        {
                            _ = PrivateDump(sb, os[i], "[" + i + "]", level + 1, maxLevel, false);
                        }
                    }
                    else
                    {
                        _ = PrivateDump(sb, obj.GetType().ToString() + ": N/A", obj.GetType().ToString(), level + 1, maxLevel, false);
                    }
                }
                catch (Exception)
                {
                }
            }
        }

        internal static string GetStackTrace(StackTrace st)
        {
            string rv = string.Empty;

            for (int i = 0; i < st.FrameCount; i++)
            {
                StackFrame sf = st.GetFrame(i);
                rv += sf.GetMethod() + " <= ";
            }

            return rv;
        }
    }
}