Test and manage logrotation

Author: KnifMelti

Sources/Winget-AutoUpdate/Winget-Install.ps1

@@ -71,6 +71,7 @@ else {
 . "$realPath\functions\Write-ToLog.ps1"
 . "$realPath\functions\Confirm-Installation.ps1"
 . "$realPath\functions\Compare-SemVer.ps1"
+. "$realPath\functions\Invoke-LogRotation.ps1"
 
 #Check if App exists in Winget Repository
 function Confirm-Exist ($AppID) {
@@ -268,6 +269,33 @@ function Remove-WAUWhiteList ($AppID) {
     }
 }
 
+# Function to check log file status
+function Test-LogFileStatus {
+    # Maximum number of log files to keep. Default is 3. Setting MaxLogFiles to 0 will keep all log files.
+    $MaxLogFiles = $WAUConfig.WAU_MaxLogFiles
+    if ($null -eq $MaxLogFiles) {
+        [int32]$MaxLogFiles = 3;
+    }
+    else {
+        [int32]$MaxLogFiles = $MaxLogFiles;
+    }
+
+    # Maximum size of log file.
+    $MaxLogSize = $WAUConfig.WAU_MaxLogSize;
+    if (!$MaxLogSize) {
+        [int64]$MaxLogSize = [int64]1MB; # in bytes, default is 1 MB = 1048576
+    }
+    else {
+        [int64]$MaxLogSize = $MaxLogSize;
+    }
+
+    #LogRotation
+    [bool]$LogRotate = Invoke-LogRotation $LogFile $MaxLogFiles $MaxLogSize;
+    if ($false -eq $LogRotate) {
+        Write-ToLog "An Exception occurred during Log Rotation..." -Component "WinGet-Install"
+    }
+}
+
 <# MAIN #>
 
 #If running as a 32-bit process on an x64 system, re-launch as a 64-bit process
@@ -319,12 +347,15 @@ if (!(Test-Path $LogPath)) {
     New-Item -ItemType Directory -Force -Path $LogPath | Out-Null
 }
 
+# Test the status of the log files
+Test-LogFileStatus
+
 #Log Header
 if ($Uninstall) {
-    Write-ToLog -LogMsg "###   NEW UNINSTALL REQUEST   ###" -LogColor "Magenta" -IsHeader -Component "WinGet-Install"
+    Write-ToLog "###   NEW UNINSTALL REQUEST   ###" -LogColor "Magenta" -IsHeader -Component "WinGet-Install"
 }
 else {
-    Write-ToLog -LogMsg "###   NEW INSTALL REQUEST   ###" -LogColor "Magenta" -IsHeader -Component "WinGet-Install"
+    Write-ToLog "###   NEW INSTALL REQUEST   ###" -LogColor "Magenta" -IsHeader -Component "WinGet-Install"
 }
 
 if ($IsElevated -eq $True) {

Sources/Winget-AutoUpdate/functions/Invoke-LogRotation.ps1

@@ -11,25 +11,23 @@ function Invoke-LogRotation {
     # if MaxLogFiles is 1 just keep the original one and let it grow
     if (-not($MaxLogFiles -eq 1)) {
         try {
-            # get current size of log file
+            # get current size of standard log file
             $currentSize = (Get-Item $LogFile).Length
 
-            # get log name
+            # get standard log name
             $logFileName = Split-Path $LogFile -Leaf
             $logFilePath = Split-Path $LogFile
             $logFileNameWithoutExtension = [System.IO.Path]::GetFileNameWithoutExtension($logFileName)
             $logFileNameExtension = [System.IO.Path]::GetExtension($logFileName)
 
             if ($currentSize -ge $MaxLogSize) {
+                $logrotate = $true
 
                 # construct name of archived log file
                 $newLogFileName = $logFileNameWithoutExtension + (Get-Date -Format 'yyyyMMddHHmmss').ToString() + $logFileNameExtension
                 # rename old log file
                 Rename-Item -Path $LogFile -NewName $newLogFileName -Force -Confirm:$false
 
-                # create new file
-                Write-ToLog "New log file created"
-
                 # if MaxLogFiles is 0 don't delete any old archived log files
                 if (-not($MaxLogFiles -eq 0)) {
 
@@ -48,11 +46,58 @@ function Invoke-LogRotation {
                         }
                     }
                 }
+            }
+
+            # CM log file name
+            $CMLogFile = $LogFile -replace "\.log$", "_CM.log"
+
+            # get current size of CM log file if it exists
+            if (Test-Path $CMLogFile) {
+                $currentCMSize = (Get-Item $CMLogFile).Length
+
+                # get CM log name
+                $logFileName = Split-Path $CMLogFile -Leaf
+                $logFilePath = Split-Path $CMLogFile
+                $logFileNameWithoutExtension = [System.IO.Path]::GetFileNameWithoutExtension($logFileName)
+                $logFileNameExtension = [System.IO.Path]::GetExtension($logFileName)
+
+                if ($currentCMSize -ge $MaxLogSize) {
+                    $CM_logrotate = $true
+
+                    # construct name of archived log file
+                    $newLogFileName = $logFileNameWithoutExtension + (Get-Date -Format 'yyyyMMddHHmmss').ToString() + $logFileNameExtension
+                    # rename old log file
+                    Rename-Item -Path $CMLogFile -NewName $newLogFileName -Force -Confirm:$false
+
+                    # if MaxLogFiles is 0 don't delete any old archived log files
+                    if (-not($MaxLogFiles -eq 0)) {
+
+                        # set filter to search for archived log files
+                        $archivedLogFileFilter = $logFileNameWithoutExtension + '??????????????' + $logFileNameExtension
+
+                        # get archived log files
+                        $oldLogFiles = Get-Item -Path "$(Join-Path -Path $logFilePath -ChildPath $archivedLogFileFilter)"
+
+                        if ([bool]$oldLogFiles) {
+                            # compare found log files to MaxLogFiles parameter of the log object, and delete oldest until we are
+                            # back to the correct number
+                            if (($oldLogFiles.Count + 1) -gt $MaxLogFiles) {
+                                [int]$numTooMany = (($oldLogFiles.Count) + 1) - $MaxLogFiles
+                                $oldLogFiles | Sort-Object 'LastWriteTime' | Select-Object -First $numTooMany | Remove-Item
+                            }
+                        }
+                    }
+                }
+            }
 
-                #Log Header
-                Write-ToLog -LogMsg "CHECK FOR APP UPDATES (System context)" -IsHeader
-                Write-ToLog -LogMsg "Max Log Size reached: $MaxLogSize bytes - Rotated Logs"
+            # Log actions
+            if ($logrotate) {
+                Write-ToLog "###   Max Standard log size reached: $MaxLogSize bytes - Rotated Logs   ###"
             }
+            if ($CM_logrotate) {
+                Write-ToLog "###   Max CM log size reached: $MaxLogSize bytes - Rotated CM Logs   ###"
+            }  
+
             # end of try block
             Return $true;
         }