Add rudimentarry logging support with a setting to choose the level (currently defaulting to off)

Author: ReplicaObscura

Lib/Launchpad/Config/AppConfig.ahk

@@ -61,7 +61,7 @@
 
     RebuildExistingLaunchers {
         get => this.GetBooleanValue("RebuildExistingLaunchers", true)
-        set => this.SetIniValue("RebuildExistingLaunchers", value)
+        set => this.SetBooleanValue("RebuildExistingLaunchers", value)
     }
 
     CreateIndividualDirs {
@@ -94,6 +94,11 @@
         set => this.SetBooleanValue("FlushCacheOnExit", value)
     }
 
+    LoggingLevel {
+        get => this.GetIniValue("LoggingLevel") || "None"
+        set => this.SetIniValue("LoggingLevel", value)
+    }
+
     __New(app, defaultTempDir, defaultAppDataDir) {
         InvalidParameterException.CheckTypes("ValidateLaunchersOp", "defaultTempDir", defaultTempDir, "", "defaultAppDataDir", defaultAppDataDir, "")
         InvalidParameterException.CheckEmpty("ValidateLaunchersOp", "defaultTempDir", defaultTempDir, "defaultAppDataDir", defaultAppDataDir)

Lib/Launchpad/Launchpad.ahk

@@ -82,6 +82,11 @@
         set => this.blizzardProductDbObj := value
     }
 
+    Logger {
+        get => this.loggerServiceObj
+        set => this.loggerServiceObj := value
+    }
+
     __New(appName, appDir) {
         InvalidParameterException.CheckTypes("Launchpad", "appName", appName, "", "appDir", appDir, "")
         this.appName := appName
@@ -90,13 +95,16 @@
         DirCreate(this.tmpDir)
         DirCreate(this.appDataDir)
 
-        idGen := UuidGenerator.new()
+        
         config := AppConfig.new(this, this.tmpDir, this.appDataDir)
+        idGen := UuidGenerator.new()
         appStateObj := LaunchpadAppState.new(this.appDataDir . "\State.json")
         eventManagerObj := EventManager.new()
 
         this.idGen := idGen
         this.appConfigObj := config
+
+        this.loggerServiceObj := LoggerService.new(FileLogger.new(A_ScriptDir . "\log.txt", config.LoggingLevel, 5))
         this.appStateObj := appStateObj
         this.blizzardProductDbObj := BlizzardProductDb.new(this)
         this.eventManagerObj := eventManagerObj

Lib/Launchpad/Window/SettingsWindow.ahk

@@ -1,5 +1,6 @@
 class SettingsWindow extends LaunchpadGuiBase {
     availableThemes := Map()
+    logLevels := ["None", "Error", "Warning", "Info", "Debug"]
 
     __New(app, windowKey := "", owner := "", parent := "") {
         this.availableThemes := app.Themes.GetAvailableThemes(true)
@@ -61,6 +62,11 @@
         this.AddHeading("Cache Settings")
         this.AddConfigCheckBox("Flush cache on exit", "FlushCacheOnExit")
 
+        this.AddHeading("Logging Level")
+        chosen := this.GetItemIndex(this.logLevels, this.app.Config.LoggingLevel)
+        ctl := this.guiObj.AddDDL("vLoggingLevel xs y+m Choose" . chosen . " w" . this.windowSettings["contentWidth"], this.logLevels)
+        ctl.OnEvent("Change", "OnLoggingLevelChange")
+
         tabs.UseTab()
 
         closeW := 100
@@ -194,4 +200,9 @@
         this.app.Config.ThemeName := this.availableThemes[ctl.Value]
         this.app.Themes.LoadMainTheme()
     }
+
+    OnLoggingLevelChange(ctl, info) {
+        this.guiObj.Submit(false)
+        this.app.Config.LoggingLevel := ctl.Text
+    }
 }

Lib/Shared/Includes.ahk

@@ -50,6 +50,8 @@
 #Include E:\Tools\Launchpad\Lib\Shared\Launcher\SimpleLauncher.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\LayeredData\LayeredDataBase.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\LayeredData\LayeredEntityData.ahk
+#Include E:\Tools\Launchpad\Lib\Shared\Logger\FileLogger.ahk
+#Include E:\Tools\Launchpad\Lib\Shared\Logger\LoggerBase.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\Notifier\NotifierBase.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\Notifier\ToastNotifier.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\OpError\BasicOpError.ahk
@@ -60,6 +62,7 @@
 #Include E:\Tools\Launchpad\Lib\Shared\Service\ComponentServiceBase.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\Service\DataSourceManager.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\Service\EventManager.ahk
+#Include E:\Tools\Launchpad\Lib\Shared\Service\LoggerService.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\Service\ServiceBase.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\Theme\JsonTheme.ahk
 #Include E:\Tools\Launchpad\Lib\Shared\Theme\ThemeBase.ahk

Lib/Shared/Logger/FileLogger.ahk

@@ -0,0 +1,32 @@
+class FileLogger extends LoggerBase {
+    path := ""
+    loggingLevel := ""
+    levels := ["None", "Debug", "Info", "Warning", "Error"]
+
+    __New(path, loggingLevel := "", autoTruncate := false) {
+        this.path := path
+
+        super.__New(loggingLevel)
+
+        if (autoTruncate) {
+            this.autoTruncate := autoTruncate
+            this.Truncate(autoTruncate)
+        }
+    }
+
+    Truncate(truncateSize) {
+        if (truncateSize and this.path != "" and FileExist(this.path)) {
+            size := FileGetSize(this.path, "M")
+            
+            if (size >= truncateSize) {
+                FileDelete(this.path)
+            }
+        }
+    }
+
+    Log(message, level := "Info") {
+        if super.Log(message, level) {
+            FileAppend("[" . FormatTime() . "] - [" . level . "] - " . message . "`n", this.path)
+        }
+    }
+}

Lib/Shared/Logger/LoggerBase.ahk

@@ -0,0 +1,34 @@
+class LoggerBase {
+    loggingLevel := ""
+
+    __New(loggingLevel := "") {
+        if (loggingLevel == "") {
+            loggingLevel := "Error"
+        }
+
+        this.loggingLevel := loggingLevel
+    }
+
+    Log(message, level := "info") {
+        shouldContinue := false
+
+        minLevel := 1
+        reqLevel := 1
+
+        for index, loggingLevel in this.levels {
+            if (this.loggingLevel == loggingLevel) {
+                minLevel := index
+                break
+            }
+        }
+
+        for index, loggingLevel in this.levels {
+            if (loggingLevel == level) {
+                reqLevel := index
+                break
+            }
+        }
+
+        return (reqLevel > 1 and minLevel > 1 and reqLevel >= minLevel)
+    }
+}

Lib/Shared/Service/LoggerService.ahk

@@ -0,0 +1,27 @@
+class LoggerService {
+    logger := ""
+
+    __New(logger) {
+        this.logger := logger
+    }
+
+    Log(message, level := "info") {
+        this.logger.write(message, level)
+    }
+
+    Debug(message) {
+        this.Log(message, "debug")
+    }
+
+    Info(message) {
+        this.Log(message, "info")
+    }
+
+    Warning(message) {
+        this.Log(message, "warning")
+    }
+
+    Error(message) {
+        this.log(message, "error")
+    }
+}