Windows settings time

.github/actions/spelling/allow.txt

@@ -67,4 +67,4 @@ websites
 wekyb
 Hmmss
 MMdd
-MMdd
+immersivecontrolpanel

.github/actions/spelling/expect/generic_terms.txt

@@ -19,9 +19,9 @@ ssh
 usr
 versioning
 VGpu
-<<<<<<< HEAD
 Ntp
 Systray
-=======
 ADDLOCAL
->>>>>>> b9c45c87b2a62b479e107979ab3714073a765e8e
+dstoff
+tzautoupdate
+tzutil

resources/Help/Microsoft.Windows.Setting.Time/TimeZone.md

@@ -4,39 +4,39 @@ Module Name: Microsoft.Windows.Setting.Time
 ms.date: 05/11/2024
 online version:
 schema: 2.0.0
-title: Time
+title: TimeZone
 ---
 
 # Time
 
 ## SYNOPSIS
 
-This `Time` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
+This `TimeZone` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
 
 ## DESCRIPTION
 
-This `Time` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
+This `TimeZone` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
 
 ## PARAMETERS
 
-| **Parameter**              | **Attribute** | **DataType** | **Description**                                                                                                                                                                                                          | **Allowed Values**                                                |
-| -------------------------- | ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
-| `TimeZone`                 | Key           | String       | Specifies the time zone to set on the machine.                                                                                                                                                                           | Any valid time zone identifier from `Get-TimeZone -ListAvailable` |
-| `SetTimeZoneAutomatically` | Optional      | Boolean      | Whether to set the time zone automatically. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Set time automatically.                                       |     `$true`, `$false`                                                              |
-| `AdjustForDayLightSaving`  | Optional      | Boolean      | Whether to adjust for daylight saving time. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Adjust for daylight saving time automatically. | `$true`, `$false` |
-
+| **Parameter**              | **Attribute** | **DataType** | **Description**                                                                                                                                                                                                                                                                            | **Allowed Values**                                                |
+| -------------------------- | ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
+| `Id`                       | Key           | String       | Specifies the time zone to set on the machine.                                                                                                                                                                                                                                             | Any valid time zone identifier from `Get-TimeZone -ListAvailable` |
+| `SetTimeZoneAutomatically` | Optional      | Boolean      | Whether to set the time zone automatically. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Set time zone automatically.                                       |     `$true`, `$false`                                          |
+| `SetTimeAutomatically`     | Optional      | Boolean      | Whether to set the time automatically. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Set time automatically.                                       |     `$true`, `$false`                                          |
+| `AdjustForDayLightSaving`  | Optional      | Boolean      | Whether to adjust for daylight saving time. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Adjust for daylight saving time automatically. | `$true`, `$false`                  |
 
 ## EXAMPLES
 
 ### EXAMPLE 1 - Set time zone to Pacific Standard Time
 
 ```powershell
-Invoke-DscResource -Name Time -Method Set -Property @{ TimeZone = "Pacific Standard Time"}
+Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Set -Property @{ Id = "Pacific Standard Time"}
 
 # This example sets the time zone to Pacific Standard Time.
 ```
 
-### EXAMPLE 2
+### EXAMPLE 2 - Get current time zone
 
 ```powershell
 Invoke-DscResource -Name Time -Method Get -Property {}

resources/Microsoft.Windows.Setting.Time/Microsoft.Windows.Setting.Time.psm1

@@ -1,5 +1,6 @@
 if ([string]::IsNullOrEmpty($env:TestRegistryPath)) {
-    $global:tzAutoUpdatePath = 'HKLM:\SYSTEM\CurrentControlSet\Services\W32Time\Parameters'
+    $global:tzAutoUpdatePath = 'HKLM:\System\CurrentControlSet\Services\tzautoupdate'
+    $global:w32TimePath = 'HKLM:\SYSTEM\CurrentControlSet\Services\W32Time\Parameters'
     $global:timeZoneInformationPath = 'HKLM:\SYSTEM\CurrentControlSet\Control\TimeZoneInformation'
 } else {
     $global:tzAutoUpdatePath = $global:timeZoneInformationPath = $env:TestRegistryPath
@@ -39,57 +40,107 @@ function Get-ValidTimeZone {
 
     return $timeZoneId
 }
+
+function Test-LocationSettingPermission {
+    # On Windows 11, the HKLM is the location services, whereas HKCU is the Let apps access your location setting
+    $registryKeys = @('HKLM:\Software\Microsoft\Windows\CurrentVersion\CapabilityAccessManager\ConsentStore\location', 'HKCU:\Software\Microsoft\Windows\CurrentVersion\CapabilityAccessManager\ConsentStore\location', 'HKCU:\Software\Microsoft\Windows\CurrentVersion\CapabilityAccessManager\ConsentStore\location\windows.immersivecontrolpanel*')
+    foreach ($key in $registryKeys) {
+        $res = Get-ItemProperty -Path $key -Name 'Value' -ErrorAction SilentlyContinue
+        if ($res.Value -ne 'Allow') {
+            # TODO: Or should we throw an error?
+            return $false
+        }
+    }
+
+    return $true
+}
+
+function Set-DaylightSavingTime {
+    param (
+        [Parameter()]
+        [switch] $Enable,
+
+        [Parameter(Mandatory = $true)]
+        [string] $Id
+    )
+
+    $command = $Enable.IsPresent ? ('tzutil /s "{0}"' -f $Id) : ('tzutil /s "{0}_dstoff"' -f $Id)
+
+    Invoke-Expression -Command $command
+
+    if ($LASTEXITCODE -ne 0) {
+        throw [System.Configuration.ConfigurationException]::new("Failed to set daylight saving time. Error: $LASTEXITCODE")
+    }
+}
 #endRegion Functions
 
 #region Classes
 <#
 .SYNOPSIS
-    This `Time` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
+    This `TimeZone` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
 
 .DESCRIPTION
-    This `Time` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
+    This `TimeZone` DSC Resource allows you to manage the time zone, automatic time zone update, and system tray date/time visibility settings on a Windows machine.
 
-.PARAMETER TimeZone
-    The time zone to set on the machine. The value should be a valid time zone ID from the list of time zones (Get-TimeZone -ListAvailable).Id. The default value is the current time zone.
+.PARAMETER Id
+    The Id to set on the machine. The value should be a valid time zone ID from the list of time zones (Get-TimeZone -ListAvailable).Id. The default value is the current time zone.
 
 .PARAMETER SetTimeZoneAutomatically
-    Whether to set the time zone automatically. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Set time automatically.
+    Whether to set the time zone automatically. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Set time zone automatically.
+
+.PARAMETER SetTimeAutomatically
+    Whether to set the time automatically. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Set time automatically.
 
 .PARAMETER AdjustForDaylightSaving
     Whether to adjust for daylight saving time. The value should be a boolean. You can find the setting in `Settings -> Time & Language -> Date & Time -> Adjust for daylight saving time automatically.
 
 .EXAMPLE
-    PS C:\> Invoke-DscResource -Name Time -Method Set -Property @{ TimeZone = "Pacific Standard Time"}
+    PS C:\> Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Set -Property @{ TimeZone = "Pacific Standard Time"}
 
     This example sets the time zone to Pacific Standard Time.
 
 .EXAMPLE
-    PS C:\> Invoke-DscResource -Name Time -Method Get -Property {}
+    PS C:\> Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Get -Property {}
 
     This example gets the current time settings on the machine.
 #>
 [DscResource()]
 class TimeZone {
     [DscProperty(Key)]
-    [string] $TimeZone
+    [string] $Id
 
     [DscProperty()]
     [nullable[bool]] $SetTimeZoneAutomatically
 
+    [DscProperty()]
+    [nullable[bool]] $SetTimeAutomatically
+
     [DscProperty()]
     [nullable[bool]] $AdjustForDaylightSaving
 
-    static hidden [string] $SetTimeZoneAutomaticallyProperty = 'Type'
+    static hidden [string] $SetTimeZoneAutomaticallyProperty = 'Start'
+    static hidden [string] $SetTimeAutomaticallyProperty = 'Type'
     static hidden [string] $AdjustForDaylightSavingProperty = 'DynamicDaylightTimeDisabled'
+    static hidden [string] $NtpEnabled = 'NTP'
+    static hidden [string] $NtpDisabled = 'NoSync'
+    static hidden [bool] $SupportsDaylightSavingProperty = $false
 
     TimeZone() {
-        $this.TimeZone = (Get-TimeZone).Id
+        $timeZone = Get-TimeZone
+        $this.Id = $timeZone.Id
+
+        # We set the SupportsDaylightSavingProperty to the value that is supported by the current time zone
+        [TimeZone]::SupportsDaylightSavingProperty = $timeZone.SupportsDaylightSavingTime ? $true : $false
     }
 
     [TimeZone] Get() {
         $currentState = [TimeZone]::new()
-        $currentState.SetTimeZoneAutomatically = [TimeZone]::GetTimeZoneAutoUpdateStatus()
-        $currentState.AdjustForDaylightSaving = [TimeZone]::GetDayLightSavingStatus()
+        $currentState.SetTimeZoneAutomatically = [TimeZone]::GetTimeZoneAutomaticallyStatus()
+        $currentState.SetTimeAutomatically = [TimeZone]::GetTimeAutomaticallyStatus()
+
+        if ($currentState::SupportsDaylightSavingProperty) {
+            $currentState.AdjustForDaylightSaving = [TimeZone]::GetDayLightSavingStatus()
+        }
 
         return $currentState
     }
@@ -101,55 +152,82 @@ class TimeZone {
 
         $currentState = $this.Get()
 
-        if ($currentState.TimeZone -ne $this.TimeZone) {
-            Set-TimeZone -Id (Get-ValidTimeZone -TimeZone $this.TimeZone)
+        if ($currentState.Id -ne $this.Id) {
+            Set-TimeZone -Id (Get-ValidTimeZone -TimeZone $this.Id)
+        }
+
+        if (($null -ne $this.SetTimeZoneAutomatically) -and ($this.SetTimeZoneAutomatically -ne $currentState.SetTimeZoneAutomatically)) {
+            $desiredState = $this.SetTimeZoneAutomatically ? 3 : 4
+
+            if (Test-LocationSettingPermission) {
+                Set-ItemProperty -Path $global:tzAutoUpdatePath -Name ([TimeZone]::SetTimeZoneAutomaticallyProperty) -Value $desiredState
+            }
         }
 
-        if ($currentState.SetTimeZoneAutomatically -ne $this.SetTimeZoneAutomatically) {
+        if (($null -ne $this.SetTimeAutomatically) -and ($this.SetTimeAutomatically -ne $currentState.SetTimeAutomatically)) {
             $desiredState = $this.SetTimeAutomatically ? [TimeZone]::NtpEnabled : [TimeZone]::NtpDisabled
 
-            Set-ItemProperty -Path $global:tzAutoUpdatePath -Name ([TimeZone]::SetTimeZoneAutomaticallyProperty) -Value $desiredState
+            Set-ItemProperty -Path $global:w32TimePath -Name ([TimeZone]::SetTimeAutomaticallyProperty) -Value $desiredState
         }
 
-        if ($currentState.AdjustForDaylightSaving -ne $this.AdjustForDaylightSaving) {
-            $desiredState = $this.AdjustForDaylightSaving ? 0 : 1
+        if ($currentState::SupportsDaylightSavingProperty -and ($null -ne $this.AdjustForDaylightSaving)) {
+            $desiredState = @{
+                Id     = $this.Id
+                Enable = $this.AdjustForDaylightSaving
+            }
 
-            Set-ItemProperty -Path $global:timeZoneInformationPath -Name ([TimeZone]::AdjustForDaylightSavingProperty) -Value $desiredState
+            if ($this.AdjustForDaylightSaving -ne $currentState.AdjustForDaylightSaving) {
+                # Falling back on tzutil because the amount of registry keys to modify is too high, plus difficult to determine which one to modify
+                Set-DaylightSavingTime @desiredState
+            }
         }
     }
 
     [bool] Test() {
         $currentState = $this.Get()
 
-        if (($null -ne $this.TimeZone) -and ($this.TimeZone -ne $currentState.TimeZone)) {
+        if ($this.Id -ne $currentState.Id) {
             return $false
         }
 
         if (($null -ne $this.SetTimeZoneAutomatically) -and ($this.SetTimeZoneAutomatically -ne $currentState.SetTimeZoneAutomatically)) {
             return $false
         }
 
-        if (($null -ne $this.AdjustForDaylightSaving) -and ($this.AdjustForDaylightSaving -ne $currentState.AdjustForDaylightSaving)) {
+        if (($null -ne $this.SetTimeAutomatically) -and ($this.SetTimeAutomatically -ne $currentState.SetTimeAutomatically)) {
             return $false
         }
 
+        if ($currentState::SupportsDaylightSavingProperty -and ($null -ne $this.AdjustForDaylightSaving)) {
+            if ($this.AdjustForDaylightSaving -ne $currentState.AdjustForDaylightSaving) {
+                return $false
+            }
+        }
+
         return $true
     }
 
-    #region Time helper functions
-    static [bool] GetTimeZoneAutoUpdateStatus() {
-        # key should actually always be present, but we'll check anyway
+    #region TimeZone helper functions
+    static [bool] GetTimeZoneAutomaticallyStatus() {
         $keyValue = TryGetRegistryValue -Key $global:tzAutoUpdatePath -Property ([TimeZone]::SetTimeZoneAutomaticallyProperty)
         if ($null -eq $keyValue) {
             return $true
         } else {
-            return ($keyValue -eq 1)
+            return ($keyValue -eq 3)
+        }
+    }
+
+    static [bool] GetTimeAutomaticallyStatus() {
+        $keyValue = TryGetRegistryValue -Key $global:w32TimePath -Property ([TimeZone]::SetTimeAutomaticallyProperty)
+        if ($null -eq $keyValue) {
+            return $true
+        } else {
+            return ($keyValue -eq 'NTP')
         }
     }
 
     static [bool] GetDayLightSavingStatus() {
-        # key should actually always be present, but we'll check anyway
-        $keyValue = TryGetRegistryValue -Key $global:timeZoneInformationPath -Property ([TimeZone]::SetTimeZoneAutomaticallyProperty)
+        $keyValue = TryGetRegistryValue -Key $global:timeZoneInformationPath -Property ([TimeZone]::AdjustForDaylightSavingProperty)
         if ($null -eq $keyValue) {
             return $true
         } else {
@@ -168,7 +246,7 @@ class TimeZone {
 
         return $parameters
     }
-    #endRegion Time helper functions
+    #endRegion TimeZone helper functions
 }
 
 if ([string]::IsNullOrEmpty($env:TestRegistryPath)) {
@@ -302,6 +380,7 @@ class Clock {
         return $parameters
     }
     #endRegion Clock helper functions
+
 }
 #endRegion Classes
 

tests/Microsoft.Windows.Setting.Time/Microsoft.Windows.Setting.Time.Tests.ps1

@@ -32,30 +32,38 @@ Describe 'List available DSC resources' {
 }
 
 Describe 'TimeZone' {
-    It 'Set Time Zone' {
-        $desiredState = @{ TimeZone = 'Pacific Standard Time' }
+    It 'Set Time Zone only by Id' {
+        $desiredState = @{ Id = 'Pacific Standard Time' }
 
         Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Set -Property $desiredState
 
         $finalState = Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Test -Property @{}
         $finalState.InDesiredState | Should -Be $true
     }
 
-    It 'Set automatic time zone not synchronize' {
-        $object = [TimeZone]::new()
-        $object.SetTimeZoneAutomatically = 'NoSync'
+    It 'Set Time Zone automatically' {
+        $desiredState = @{ Id = 'W. Europe Standard Time'; SetTimeZoneAutomatically = $true }
 
-        # Set the state
-        $object.Set()
+        Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Set -Property $desiredState
+
+        $finalState = Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Test -Property @{}
+        $finalState.InDesiredState | Should -Be $true
+    }
 
-        # Test the state
-        $object.Test() | Should -Be $true
+    It 'Disable Time automatically' {
+        $desiredState = @{ Id = 'W. Europe Standard Time'; SetTimeAutomatically = $false }
+
+        Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Set -Property $desiredState
+
+        $finalState = Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Test -Property @{}
+        $finalState.InDesiredState | Should -Be $true
     }
 
     It 'Disable daylight saving' {
         $desiredState = @{
-            TimeZone                = (Get-TimeZone).Id
-            AdjustForDaylightSaving = $false
+            Id                       = (Get-TimeZone -ListAvailable | Where-Object { $_.SupportsDaylightSavingTime -eq $true } | Select-Object -First 1 -ExpandProperty Id)
+            SetTimeZoneAutomatically = $false
+            AdjustForDaylightSaving  = $false
         }
 
         Invoke-DscResource -Name TimeZone -ModuleName Microsoft.Windows.Setting.Time -Method Set -Property $desiredState