Merge branch 'master' into develop

Config/Apps.json

@@ -781,7 +781,7 @@
     {
       "FriendlyName": "Windows Terminal",
       "AppId": "Microsoft.WindowsTerminal",
-      "Description": "Default terminal app in windows 11 (Command Prompt, PowerShell, WSL), WARNING: Win11Debloat if it is launched via Windows Terminal.",
+      "Description": "Default terminal app in windows 11 (Command Prompt, PowerShell, WSL), WARNING: Do not remove if you launched Win11Debloat from Windows Terminal, as this will cause the script to fail.",
       "SelectedByDefault": false,
       "Recommendation": "unsafe"
     },

Scripts/Features/BackupRegistrySnapshotCapture.ps1

@@ -147,31 +147,14 @@ function Invoke-WithLoadedBackupHive {
         $ArgumentObject = $null
     )
 
-    $hiveDatPath = if ($script:Params.ContainsKey('Sysprep')) {
+    $targetUserName = if ($script:Params.ContainsKey('Sysprep')) {
-        GetUserDirectory -userName 'Default' -fileName 'NTUSER.DAT'
+        'Default'
     }
     else {
-        GetUserDirectory -userName $script:Params.Item('User') -fileName 'NTUSER.DAT'
+        $script:Params.Item('User')
     }
 
-    $global:LASTEXITCODE = 0
+    return Invoke-WithTargetUserHive -TargetUserName $targetUserName -ScriptBlock $ScriptBlock -ArgumentObject $ArgumentObject
-    reg load 'HKU\Default' "$hiveDatPath" | Out-Null
-    $loadExitCode = $LASTEXITCODE
-    if ($loadExitCode -ne 0) {
-        throw "Failed to load user hive for registry backup at '$hiveDatPath' (exit code: $loadExitCode)"
-    }
-
-    try {
-        return & $ScriptBlock $ArgumentObject
-    }
-    finally {
-        $global:LASTEXITCODE = 0
-        reg unload 'HKU\Default' | Out-Null
-        $unloadExitCode = $LASTEXITCODE
-        if ($unloadExitCode -ne 0) {
-            throw "Failed to unload registry hive 'HKU\Default' (exit code: $unloadExitCode)"
-        }
-    }
 }
 
 function Get-RegistryKeySnapshot {

Scripts/Features/ExecuteChanges.ps1

@@ -128,7 +128,14 @@ function ExecuteParameter {
 
 
 # Executes all selected parameters/features
-function ExecuteAllChanges {    
+function ExecuteAllChanges {
+    # When running as SYSTEM, require -User or -Sysprep to prevent applying
+    # changes to the SYSTEM profile instead of a real user.
+    $isSystem = ([Security.Principal.WindowsIdentity]::GetCurrent().User.Value -eq 'S-1-5-18')
+    if ($isSystem -and -not $script:Params.ContainsKey("User") -and -not $script:Params.ContainsKey("Sysprep")) {
+        throw "Win11Debloat is running as the SYSTEM account. Use the '-User' or '-Sysprep' parameter to target a specific user."
+    }
+
     $script:RegistryImportFailures = 0
 
     # Build list of actionable parameters (skip control params and data-only params)

Scripts/Features/ImportRegistryFile.ps1

@@ -18,24 +18,19 @@ function ImportRegistryFile {
         throw $errorMessage
     }
 
-    $regResult = $null
+    $importScript = {
-    $offlineHiveLoaded = $false
+        param($targetRegFilePath, $hiveContext)
 
-    try {
+        # When the target user's hive is already loaded under their SID, the .reg file's
-        if ($usesOfflineHive) {
+        # HKEY_USERS\Default paths won't match. Use the PowerShell registry writer instead,
-            # Sysprep targets Default user, User targets the specified user
+        # which remaps Default → SID via Split-RegistryPath.
-            $targetUserName = if ($script:Params.ContainsKey("Sysprep")) { "Default" } else { $script:Params.Item("User") }
+        $usePowerShellFallbackOnly = $hiveContext -and [bool]$hiveContext.WasAlreadyLoaded
-            $hiveDatPath = GetUserDirectory -userName $targetUserName -fileName "NTUSER.DAT"
 
-            $global:LASTEXITCODE = 0
+        if ($usePowerShellFallbackOnly) {
-            reg load "HKU\Default" $hiveDatPath | Out-Null
+            Invoke-RegistryOperationsFromRegFile -RegFilePath $targetRegFilePath
-            $loadExitCode = $LASTEXITCODE
+            Write-Host "The operation completed successfully via PowerShell registry writer."
-
+            Write-Host ""
-            if ($loadExitCode -ne 0) {
+            return
-                throw "Failed importing registry file '$path'. Offline hive load failed: Failed to load user hive at '$hiveDatPath' (exit code: $loadExitCode)"
-            }
-
-            $offlineHiveLoaded = $true
         }
 
         $regResult = Invoke-NonBlocking -ScriptBlock {
@@ -66,7 +61,7 @@ function ImportRegistryFile {
             }
 
             return $result
-        } -ArgumentList $regFilePath
+        } -ArgumentList $targetRegFilePath
 
         $regOutput = @($regResult.Output)
         $hasSuccess = ($regResult.ExitCode -eq 0) -and -not $regResult.Error
@@ -88,26 +83,26 @@ function ImportRegistryFile {
         if (-not $hasSuccess) {
             $details = if ($regResult.Error) { $regResult.Error } else { "Exit code: $($regResult.ExitCode)" }
             Write-Warning "reg import failed for '$path'. Falling back to PowerShell registry writer. Details: $details"
-            Invoke-RegistryOperationsFromRegFile -RegFilePath $regFilePath
+            Invoke-RegistryOperationsFromRegFile -RegFilePath $targetRegFilePath
-            Write-Host "Fallback import succeeded for '$path'." -ForegroundColor Yellow
+            Write-Host "The operation completed successfully via PowerShell registry writer."
         }
 
         Write-Host ""
     }
+
+    try {
+        if ($usesOfflineHive) {
+            # Sysprep targets Default user, User targets the specified user. Logged-in users already have their hive mounted under HKU\<SID>.
+            $targetUserName = if ($script:Params.ContainsKey("Sysprep")) { "Default" } else { $script:Params.Item("User") }
+            Invoke-WithTargetUserHive -TargetUserName $targetUserName -ScriptBlock $importScript -ArgumentObject $regFilePath -PassHiveContext
+        }
+        else {
+            & $importScript $regFilePath $null
+        }
+    }
     catch {
         $script:RegistryImportFailures++
         Write-Host $_.Exception.Message -ForegroundColor Red
         Write-Host ""
     }
-    finally {
+}
-        if ($offlineHiveLoaded) {
-            $global:LASTEXITCODE = 0
-            reg unload "HKU\Default" | Out-Null
-            $unloadExitCode = $LASTEXITCODE
-
-            if ($unloadExitCode -ne 0) {
-                Write-Warning "Failed to unload registry hive HKU\Default after importing '$path' (exit code: $unloadExitCode)"
-            }
-        }
-    }
-}

Scripts/Features/RestartExplorer.ps1

@@ -1,8 +1,13 @@
 # Restart the Windows Explorer process
 function RestartExplorer {
+    # Restarting Explorer while running in Sysprep or User context is not necessary
+    if ($script:Params.ContainsKey("Sysprep") -or $script:Params.ContainsKey("User")) {
+        return
+    }
+
     Write-Host "> Attempting to restart the Windows Explorer process to apply all changes..."
     
-    if ($script:Params.ContainsKey("Sysprep") -or $script:Params.ContainsKey("User") -or $script:Params.ContainsKey("NoRestartExplorer")) {
+    if ($script:Params.ContainsKey("NoRestartExplorer")) {
         Write-Host "Explorer process restart was skipped, please manually reboot your PC to apply all changes" -ForegroundColor Yellow
         return
     }

Scripts/Features/RestoreRegistryApplyState.ps1

@@ -7,38 +7,21 @@ function Invoke-WithLoadedRestoreHive {
         $ArgumentObject = $null
     )
 
-    $hiveDatPath = if ($Target -eq 'DefaultUserProfile') {
+    $targetUserName = if ($Target -eq 'DefaultUserProfile') {
-        GetUserDirectory -userName 'Default' -fileName 'NTUSER.DAT'
+        'Default'
     }
     elseif ($Target -like 'User:*') {
         $userName = $Target.Substring(5)
         if ([string]::IsNullOrWhiteSpace($userName)) {
             throw 'Invalid backup target format for user restore.'
         }
-        GetUserDirectory -userName $userName -fileName 'NTUSER.DAT'
+        $userName
     }
     else {
         throw "Unsupported backup target '$Target'."
     }
 
-    $global:LASTEXITCODE = 0
+    Invoke-WithTargetUserHive -TargetUserName $targetUserName -ScriptBlock $ScriptBlock -ArgumentObject $ArgumentObject
-    reg load 'HKU\Default' "$hiveDatPath" | Out-Null
-    $loadExitCode = $LASTEXITCODE
-    if ($loadExitCode -ne 0) {
-        throw "Failed to load target user hive '$hiveDatPath' (exit code: $loadExitCode)."
-    }
-
-    try {
-        & $ScriptBlock $ArgumentObject
-    }
-    finally {
-        $global:LASTEXITCODE = 0
-        reg unload 'HKU\Default' | Out-Null
-        $unloadExitCode = $LASTEXITCODE
-        if ($unloadExitCode -ne 0) {
-            throw "Failed to unload registry hive 'HKU\Default' (exit code: $unloadExitCode)"
-        }
-    }
 }
 
 function Restore-RegistryKeySnapshot {

Scripts/GUI/GetSystemUsesDarkMode.ps1

@@ -1,7 +1,14 @@
 # Checks if the system is set to use dark mode for apps
 function GetSystemUsesDarkMode {
     try {
-        return (Get-ItemProperty -Path 'HKCU:\Software\Microsoft\Windows\CurrentVersion\Themes\Personalize' -Name 'AppsUseLightTheme').AppsUseLightTheme -eq 0
+        $personalizeKey = Get-ItemProperty -Path 'HKCU:\Software\Microsoft\Windows\CurrentVersion\Themes\Personalize'
+
+        if ($null -eq $personalizeKey) {
+            Write-Host "WARNING: Unable to retrieve personalization settings." -ForegroundColor Yellow
+            return $false
+        }
+
+        return $personalizeKey.AppsUseLightTheme -eq 0
     }
     catch {
         return $false

Scripts/GUI/Show-MainWindow.ps1

@@ -831,6 +831,18 @@
                 }
             }
 
+        # When running as SYSTEM, the "Current User" option is not meaningful.
+        # Hide it from the dropdown and default to "Other User".
+        $isSystem = ([Security.Principal.WindowsIdentity]::GetCurrent().User.Value -eq 'S-1-5-18')
+        if ($isSystem -and $userSelectionCombo.Items.Count -gt 0) {
+            $currentUserItem = $userSelectionCombo.Items[0]
+            if ($currentUserItem -is [System.Windows.Controls.ComboBoxItem]) {
+                $currentUserItem.Visibility = 'Collapsed'
+                $currentUserItem.IsEnabled = $false
+            }
+            $userSelectionCombo.SelectedIndex = 1
+        }
+
             $restartExplorerCheckBox = $window.FindName('RestartExplorerCheckBox')
             if ($restartExplorerCheckBox -and $script:Params.ContainsKey("NoRestartExplorer")) {
                 $restartExplorerCheckBox.IsChecked = $false

Scripts/Helpers/RegistryPathHelpers.ps1

@@ -27,16 +27,19 @@ function Split-RegistryPath {
         $null
     }
 
-    if ($hiveName.Equals('HKEY_USERS', [System.StringComparison]::OrdinalIgnoreCase) -and -not [string]::IsNullOrWhiteSpace($normalizedSubKey)) {
+    if ($hiveName.Equals('HKEY_USERS', [System.StringComparison]::OrdinalIgnoreCase) -and
+        -not [string]::IsNullOrWhiteSpace($normalizedSubKey) -and
+        -not [string]::IsNullOrWhiteSpace([string]$script:RegistryTargetHiveMountName)) {
         if ($normalizedSubKey -match '^(?<mount>[^\\]+)(?:\\(?<rest>.*))?$') {
             $mountName = [string]$matches.mount
-            if ($mountName.Equals('.DEFAULT', [System.StringComparison]::OrdinalIgnoreCase)) {
+            if ($mountName.Equals('Default', [System.StringComparison]::OrdinalIgnoreCase)) {
                 $remainingSubKey = if ($matches.rest) { [string]$matches.rest } else { '' }
+                $targetMountName = [string]$script:RegistryTargetHiveMountName
                 if ([string]::IsNullOrWhiteSpace($remainingSubKey)) {
-                    $normalizedSubKey = 'Default'
+                    $normalizedSubKey = $targetMountName
                 }
                 else {
-                    $normalizedSubKey = "Default\$remainingSubKey"
+                    $normalizedSubKey = "$targetMountName\$remainingSubKey"
                 }
             }
         }

Scripts/Helpers/Test-TargetUserName.ps1

@@ -31,14 +31,6 @@ function Test-TargetUserName {
         }
     }
 
-    if (TestIfUserIsLoggedIn -Username $normalizedUserName) {
-        return [PSCustomObject]@{
-            IsValid = $false
-            UserName = $normalizedUserName
-            Message = "User '$normalizedUserName' is currently logged in. Please sign out that user first."
-        }
-    }
-
     return [PSCustomObject]@{
         IsValid = $true
         UserName = $normalizedUserName

Scripts/Helpers/TestIfUserIsLoggedIn.ps1

@@ -1,42 +0,0 @@
-function TestIfUserIsLoggedIn {
-    param(
-        [Parameter(Mandatory)]
-        [string]$Username
-    )
-
-    try {
-        $quserOutput = @(& quser 2>$null)
-        if ($LASTEXITCODE -ne 0 -or -not $quserOutput) {
-            return $false
-        }
-
-        foreach ($line in ($quserOutput | Select-Object -Skip 1)) {
-            if ([string]::IsNullOrWhiteSpace($line)) { continue }
-
-            # Remove current-session marker and split columns.
-            $normalizedLine = $line.TrimStart('>', ' ')
-            $parts = $normalizedLine -split '\s+'
-            if ($parts.Count -eq 0) { continue }
-
-            $sessionUser = $parts[0]
-            if ([string]::IsNullOrWhiteSpace($sessionUser)) { continue }
-
-            # Normalize possible DOMAIN\user or user@domain formats.
-            if ($sessionUser.Contains('\')) {
-                $sessionUser = ($sessionUser -split '\\')[-1]
-            }
-            if ($sessionUser.Contains('@')) {
-                $sessionUser = ($sessionUser -split '@')[0]
-            }
-
-            if ($sessionUser.Equals($Username, [System.StringComparison]::OrdinalIgnoreCase)) {
-                return $true
-            }
-        }
-    }
-    catch {
-        return $false
-    }
-
-    return $false
-}

Scripts/Helpers/UserHiveHelpers.ps1

@@ -0,0 +1,152 @@
+function New-TargetUserHiveContext {
+    param(
+        [Parameter(Mandatory)]
+        [string]$TargetUserName,
+        [AllowNull()]
+        [object]$UserContext,
+        [Parameter(Mandatory)]
+        [string]$HiveDatPath,
+        [AllowNull()]
+        [string]$MountName,
+        [bool]$WasAlreadyLoaded = $false,
+        [bool]$WasLoadedByScript = $false
+    )
+
+    $effectiveMountName = if ([string]::IsNullOrWhiteSpace($MountName)) { 'Default' } else { $MountName }
+
+    return [PSCustomObject]@{
+        TargetUserName = $TargetUserName
+        UserSid = if ($UserContext) { $UserContext.UserSid } else { $null }
+        ProfilePath = if ($UserContext) { $UserContext.ProfilePath } else { $null }
+        HiveDatPath = $HiveDatPath
+        MountName = $effectiveMountName
+        WasAlreadyLoaded = $WasAlreadyLoaded
+        WasLoadedByScript = $WasLoadedByScript
+    }
+}
+
+function Resolve-TargetUserHiveContext {
+    param(
+        [Parameter(Mandatory)]
+        [string]$TargetUserName
+    )
+
+    $normalizedTargetUserName = NormalizeUserLookupValue -Value $TargetUserName
+    if ([string]::IsNullOrWhiteSpace($normalizedTargetUserName)) {
+        throw 'Target user name for registry hive resolution is empty.'
+    }
+
+    $userContext = ResolveUserProfileContext -UserName $normalizedTargetUserName
+    if (-not $userContext -or [string]::IsNullOrWhiteSpace([string]$userContext.ProfilePath)) {
+        throw "Unable to resolve profile path for target user '$normalizedTargetUserName'."
+    }
+
+    $hiveDatPath = Join-Path $userContext.ProfilePath 'NTUSER.DAT'
+    if (-not (Test-Path -LiteralPath $hiveDatPath)) {
+        throw "Unable to find target user hive at '$hiveDatPath'."
+    }
+
+    $isDefaultProfile = $normalizedTargetUserName.Equals('Default', [System.StringComparison]::OrdinalIgnoreCase)
+    $userSid = if ($userContext) { [string]$userContext.UserSid } else { '' }
+
+    if ((-not $isDefaultProfile) -and (-not [string]::IsNullOrWhiteSpace($userSid))) {
+        $loadedHivePath = "Registry::HKEY_USERS\$userSid"
+        if (Test-Path -LiteralPath $loadedHivePath) {
+            return (New-TargetUserHiveContext `
+                -TargetUserName $normalizedTargetUserName `
+                -UserContext $userContext `
+                -HiveDatPath $hiveDatPath `
+                -MountName $userSid `
+                -WasAlreadyLoaded $true `
+                -WasLoadedByScript $false)
+        }
+    }
+
+    return (New-TargetUserHiveContext `
+        -TargetUserName $normalizedTargetUserName `
+        -UserContext $userContext `
+        -HiveDatPath $hiveDatPath `
+        -MountName 'Default' `
+        -WasAlreadyLoaded $false `
+        -WasLoadedByScript $false)
+}
+
+function Resolve-LoadedTargetUserHiveContext {
+    param(
+        [Parameter(Mandatory)]
+        $HiveContext
+    )
+
+    $userSid = [string]$HiveContext.UserSid
+    if ([string]::IsNullOrWhiteSpace($userSid)) {
+        return $null
+    }
+
+    $loadedHivePath = "Registry::HKEY_USERS\$userSid"
+    if (-not (Test-Path -LiteralPath $loadedHivePath)) {
+        return $null
+    }
+
+    return (New-TargetUserHiveContext `
+        -TargetUserName $HiveContext.TargetUserName `
+        -UserContext ([PSCustomObject]@{ UserSid = $HiveContext.UserSid; ProfilePath = $HiveContext.ProfilePath }) `
+        -HiveDatPath $HiveContext.HiveDatPath `
+        -MountName $userSid `
+        -WasAlreadyLoaded $true `
+        -WasLoadedByScript $false)
+}
+
+function Invoke-WithTargetUserHive {
+    param(
+        [Parameter(Mandatory)]
+        [string]$TargetUserName,
+        [Parameter(Mandatory)]
+        [scriptblock]$ScriptBlock,
+        $ArgumentObject = $null,
+        [switch]$PassHiveContext
+    )
+
+    $hiveContext = Resolve-TargetUserHiveContext -TargetUserName $TargetUserName
+    $previousHiveMountName = $script:RegistryTargetHiveMountName
+
+    try {
+        if (-not $hiveContext.WasAlreadyLoaded) {
+            $global:LASTEXITCODE = 0
+            reg load "HKU\$($hiveContext.MountName)" "$($hiveContext.HiveDatPath)" | Out-Null
+            $loadExitCode = $LASTEXITCODE
+
+            if ($loadExitCode -ne 0) {
+                $loadedSidContext = Resolve-LoadedTargetUserHiveContext -HiveContext $hiveContext
+                if ($loadedSidContext) {
+                    $hiveContext = $loadedSidContext
+                }
+                else {
+                    throw "Failed to load target user hive '$($hiveContext.HiveDatPath)' (exit code: $loadExitCode)."
+                }
+            }
+            else {
+                $hiveContext.WasLoadedByScript = $true
+            }
+        }
+
+        $script:RegistryTargetHiveMountName = [string]$hiveContext.MountName
+
+        if ($PassHiveContext) {
+            return & $ScriptBlock $ArgumentObject $hiveContext
+        }
+
+        return & $ScriptBlock $ArgumentObject
+    }
+    finally {
+        $script:RegistryTargetHiveMountName = $previousHiveMountName
+
+        if ($hiveContext -and $hiveContext.WasLoadedByScript) {
+            $global:LASTEXITCODE = 0
+            reg unload "HKU\$($hiveContext.MountName)" | Out-Null
+            $unloadExitCode = $LASTEXITCODE
+            if ($unloadExitCode -ne 0) {
+                Write-Warning "Failed to unload registry hive 'HKU\$($hiveContext.MountName)' (exit code: $unloadExitCode)"
+            }
+        }
+    }
+}

Win11Debloat.ps1

@@ -341,6 +341,7 @@ if (-not $script:WingetInstalled -and -not $Silent) {
 # Helper functions
 . "$PSScriptRoot/Scripts/Helpers/AddParameter.ps1"
 . "$PSScriptRoot/Scripts/Helpers/ResolveUserProfilePath.ps1"
+. "$PSScriptRoot/Scripts/Helpers/UserHiveHelpers.ps1"
 . "$PSScriptRoot/Scripts/Helpers/CheckIfUserExists.ps1"
 . "$PSScriptRoot/Scripts/Helpers/CheckModernStandbySupport.ps1"
 . "$PSScriptRoot/Scripts/Helpers/GenerateAppsList.ps1"
@@ -354,7 +355,6 @@ if (-not $script:WingetInstalled -and -not $Silent) {
 . "$PSScriptRoot/Scripts/Helpers/GetUserName.ps1"
 . "$PSScriptRoot/Scripts/Helpers/RegistryPathHelpers.ps1"
 . "$PSScriptRoot/Scripts/Helpers/ApplyRegistryRegFile.ps1"
-. "$PSScriptRoot/Scripts/Helpers/TestIfUserIsLoggedIn.ps1"
 . "$PSScriptRoot/Scripts/Helpers/ConfirmUnsafeAppRemoval.ps1"
 
 # Threading functions