update check frequency setting refactor

BartoszCichecki · Oct 3, 2024 · d3a8b27 · d3a8b27
1 parent d359b79
commit d3a8b27
Show file tree

Hide file tree

Showing 11 changed files with 170 additions and 194 deletions.
diff --git a/LenovoLegionToolkit.Lib/Enums.cs b/LenovoLegionToolkit.Lib/Enums.cs
@@ -610,6 +610,29 @@ public enum TouchpadLockState
     On
 }
 
+public enum UpdateCheckFrequency
+{
+    [Display(ResourceType = typeof(Resource), Name = "UpdateCheckFrequency_PerHour")]
+    PerHour,
+    [Display(ResourceType = typeof(Resource), Name = "UpdateCheckFrequency_PerThreeHours")]
+    PerThreeHours,
+    [Display(ResourceType = typeof(Resource), Name = "UpdateCheckFrequency_PerTwelveHours")]
+    PerTwelveHours,
+    [Display(ResourceType = typeof(Resource), Name = "UpdateCheckFrequency_PerDay")]
+    PerDay,
+    [Display(ResourceType = typeof(Resource), Name = "UpdateCheckFrequency_PerWeek")]
+    PerWeek,
+    [Display(ResourceType = typeof(Resource), Name = "UpdateCheckFrequency_PerMonth")]
+    PerMonth
+}
+
+public enum UpdateCheckStatus
+{
+    Success,
+    RateLimitReached,
+    Error
+}
+
 public enum WhiteKeyboardBacklightState
 {
     [Display(ResourceType = typeof(Resource), Name = "WhiteKeyboardBacklightState_Off")]
@@ -639,10 +662,3 @@ public enum WinKeyState
 }
 
 public enum WinKeyChanged;
-
-public enum UpdateCheckStatus
-{
-    Success,
-    RateLimitReached,
-    Error
-}
diff --git a/LenovoLegionToolkit.Lib/IoCModule.cs b/LenovoLegionToolkit.Lib/IoCModule.cs
@@ -40,6 +40,7 @@ protected override void Load(ContainerBuilder builder)
         builder.Register<RGBKeyboardSettings>();
         builder.Register<SpectrumKeyboardSettings>();
         builder.Register<SunriseSunsetSettings>();
+        builder.Register<UpdateCheckSettings>();
 
         builder.Register<AlwaysOnUSBFeature>();
         builder.Register<BatteryFeature>();

diff --git a/LenovoLegionToolkit.Lib/Resources/Resource.Designer.cs b/LenovoLegionToolkit.Lib/Resources/Resource.Designer.cs
diff --git a/LenovoLegionToolkit.Lib/Resources/Resource.resx b/LenovoLegionToolkit.Lib/Resources/Resource.resx
@@ -467,15 +467,33 @@
     <value>Unmute</value>
   </data>
   <data name="PowerModeMappingMode_Disabled" xml:space="preserve">
-	  <value>Disabled</value>
+    <value>Disabled</value>
   </data>
   <data name="PowerModeMappingMode_WindowsPowerMode" xml:space="preserve">
-	  <value>Windows Power Mode</value>
+    <value>Windows Power Mode</value>
   </data>
   <data name="PowerModeMappingMode_WindowsPowerPlan" xml:space="preserve">
-	  <value>Windows Power Plan</value>
+    <value>Windows Power Plan</value>
   </data>
   <data name="RGBKeyboardBacklightPreset_Four" xml:space="preserve">
-	  <value>Preset 4</value>
+    <value>Preset 4</value>
+  </data>
+  <data name="UpdateCheckFrequency_PerDay" xml:space="preserve">
+    <value>Once per day</value>
+  </data>
+  <data name="UpdateCheckFrequency_PerHour" xml:space="preserve">
+    <value>Once per hour</value>
+  </data>
+  <data name="UpdateCheckFrequency_PerMonth" xml:space="preserve">
+    <value>Once per month</value>
+  </data>
+  <data name="UpdateCheckFrequency_PerThreeHours" xml:space="preserve">
+    <value>Once per 3 hours</value>
+  </data>
+  <data name="UpdateCheckFrequency_PerTwelveHours" xml:space="preserve">
+    <value>Once per 12 hours</value>
+  </data>
+  <data name="UpdateCheckFrequency_PerWeek" xml:space="preserve">
+    <value>Once per week</value>
   </data>
 </root>
diff --git a/LenovoLegionToolkit.Lib/Settings/ApplicationSettings.cs b/LenovoLegionToolkit.Lib/Settings/ApplicationSettings.cs
@@ -47,9 +47,6 @@ public class ApplicationSettingsStore
         public bool SynchronizeBrightnessToAllPowerPlans { get; set; }
         public ModifierKey SmartFnLockFlags { get; set; }
         public bool ResetBatteryOnSinceTimerOnReboot { get; set; }
-        public int UpdateCheckMiniumTimeSpanHours { get; set; }
-        public int UpdateCheckMiniumTimeSpanMinutes { get; set; }
-        public int UpdateCheckMiniumTimeSpanSeconds { get; set; }
     }
 
     public ApplicationSettings() : base("settings.json")

diff --git a/LenovoLegionToolkit.Lib/Settings/UpdateCheckSettings.cs b/LenovoLegionToolkit.Lib/Settings/UpdateCheckSettings.cs
@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace LenovoLegionToolkit.Lib.Settings;
+
+public class UpdateCheckSettings()
+    : AbstractSettings<UpdateCheckSettings.UpdateCheckSettingsStore>("update_check.json")
+{
+    public class UpdateCheckSettingsStore
+    {
+        public DateTime? LastUpdateCheckDateTime { get; set; }
+        public UpdateCheckFrequency UpdateCheckFrequency { get; set; }
+    }
+
+    protected override UpdateCheckSettingsStore Default => new()
+    {
+        LastUpdateCheckDateTime = null,
+        UpdateCheckFrequency = UpdateCheckFrequency.PerThreeHours
+    };
+}
diff --git a/LenovoLegionToolkit.Lib/Utils/UpdateChecker.cs b/LenovoLegionToolkit.Lib/Utils/UpdateChecker.cs
@@ -15,10 +15,10 @@ namespace LenovoLegionToolkit.Lib.Utils;
 public class UpdateChecker
 {
     private readonly HttpClientFactory _httpClientFactory;
-    private readonly ApplicationSettings _settings = IoCContainer.Resolve<ApplicationSettings>();
+    private readonly UpdateCheckSettings _updateCheckSettings = IoCContainer.Resolve<UpdateCheckSettings>();
     private readonly AsyncLock _updateSemaphore = new();
 
-    private DateTime _lastUpdate = DateTime.MinValue;
+    private DateTime _lastUpdate;
     private TimeSpan _minimumTimeSpanForRefresh;
     private Update[] _updates = [];
 
@@ -29,11 +29,8 @@ public UpdateChecker(HttpClientFactory httpClientFactory)
     {
         _httpClientFactory = httpClientFactory;
 
-        CheckUpdateCheckMiniumTimeSpanSettings();
-
-        _minimumTimeSpanForRefresh = new(_settings.Store.UpdateCheckMiniumTimeSpanHours,
-                                         _settings.Store.UpdateCheckMiniumTimeSpanMinutes,
-                                         _settings.Store.UpdateCheckMiniumTimeSpanSeconds);
+        UpdateMiniumTimeSpanForRefresh();
+        _lastUpdate = _updateCheckSettings.Store.LastUpdateCheckDateTime ?? DateTime.MinValue;
     }
 
     public async Task<Version?> CheckAsync(bool forceCheck)
@@ -103,6 +100,8 @@ public UpdateChecker(HttpClientFactory httpClientFactory)
             finally
             {
                 _lastUpdate = DateTime.UtcNow;
+                _updateCheckSettings.Store.LastUpdateCheckDateTime = _lastUpdate;
+                _updateCheckSettings.SynchronizeStore();
             }
         }
     }
@@ -134,37 +133,14 @@ public async Task<string> DownloadLatestUpdateAsync(IProgress<float>? progress =
         }
     }
 
-    public void SetMinimumTimeSpanForRefresh(int hours, int minutes, int seconds) => _minimumTimeSpanForRefresh = new(hours, minutes, seconds);
-
-    private void CheckUpdateCheckMiniumTimeSpanSettings()
+    public void UpdateMiniumTimeSpanForRefresh() => _minimumTimeSpanForRefresh = _updateCheckSettings.Store.UpdateCheckFrequency switch
     {
-        bool changed = false;
-        if (_settings.Store.UpdateCheckMiniumTimeSpanHours < 3)
-        {
-            _settings.Store.UpdateCheckMiniumTimeSpanHours = 3;
-            changed = true;
-        }
-        if (_settings.Store.UpdateCheckMiniumTimeSpanMinutes < 0)
-        {
-            _settings.Store.UpdateCheckMiniumTimeSpanMinutes = 0;
-            changed = true;
-        }
-        if (_settings.Store.UpdateCheckMiniumTimeSpanMinutes > 59)
-        {
-            _settings.Store.UpdateCheckMiniumTimeSpanMinutes = 59;
-            changed = true;
-        }
-        if (_settings.Store.UpdateCheckMiniumTimeSpanSeconds < 0)
-        {
-            _settings.Store.UpdateCheckMiniumTimeSpanSeconds = 0;
-            changed = true;
-        }
-        if (_settings.Store.UpdateCheckMiniumTimeSpanSeconds > 59)
-        {
-            _settings.Store.UpdateCheckMiniumTimeSpanSeconds = 59;
-            changed = true;
-        }
-        if (changed)
-            _settings.SynchronizeStore();
-    }
+        UpdateCheckFrequency.PerHour => new(hours: 1, minutes: 0, seconds: 0),
+        UpdateCheckFrequency.PerThreeHours => new(hours: 3, minutes: 0, seconds: 0),
+        UpdateCheckFrequency.PerTwelveHours => new(hours: 2, minutes: 0, seconds: 0),
+        UpdateCheckFrequency.PerDay => new(days: 1, hours: 0, minutes: 0, seconds: 0),
+        UpdateCheckFrequency.PerWeek => new(days: 7, hours: 0, minutes: 0, seconds: 0),
+        UpdateCheckFrequency.PerMonth => new(days: 30, hours: 0, minutes: 0, seconds: 0),
+        _ => throw new ArgumentException(nameof(_updateCheckSettings.Store.UpdateCheckFrequency))
+    };
 }
diff --git a/LenovoLegionToolkit.WPF/Pages/SettingsPage.xaml b/LenovoLegionToolkit.WPF/Pages/SettingsPage.xaml
@@ -248,65 +248,18 @@
                 Visibility="Hidden" />
         </custom:CardControl>
 
-        <custom:CardControl x:Name="_updateCheckMiniumTimeSpanCard" Margin="0,0,0,8">
+        <custom:CardControl x:Name="_updateCheckFrequencyCard" Margin="0,0,0,8">
             <custom:CardControl.Header>
-                <controls:CardHeaderControl Title="{x:Static resources:Resource.SettingsPage_UpdateCheckMiniumTimeSpan_Title}" Subtitle="{x:Static resources:Resource.SettingsPage_UpdateCheckMiniumTimeSpan_Message}" />
+                <controls:CardHeaderControl Title="{x:Static resources:Resource.SettingsPage_UpdateCheckFrequency_Title}" Subtitle="{x:Static resources:Resource.SettingsPage_UpdateCheckFrequency_Message}" />
             </custom:CardControl.Header>
-            <Grid>
-                <Grid.ColumnDefinitions>
-                    <ColumnDefinition Width="Auto" />
-                    <ColumnDefinition Width="Auto" />
-                    <ColumnDefinition Width="Auto" />
-                    <ColumnDefinition Width="Auto" />
-                    <ColumnDefinition Width="Auto" />
-                    <ColumnDefinition Width="Auto" />
-                </Grid.ColumnDefinitions>
-                <TextBlock 
-                    Grid.Column="0"
-                    Margin="0,0,0,8"
-                    VerticalAlignment="Center"
-                    Text="{x:Static resources:Resource.SettingsPage_UpdateCheckMiniumTimeSpan_Picker_Hours}" />
-                <wpfui:NumberBox
-                    Grid.Column="1"
-                    x:Name="_updateCheckMiniumTimeSpanPickerHours"
-                    Margin="8,0,0,8"
-                    ClearButtonEnabled="False"
-                    MaxDecimalPlaces="0"
-                    Maximum="1440"
-                    Minimum="3"
-                    ValueChanged="UpdateCheckMiniumTimeSpanPickerHours_ValueChanged"
-                    Visibility="Hidden" />
-                <TextBlock
-                    Grid.Column="2"
-                    Margin="8,0,0,8"
-                    VerticalAlignment="Center"
-                    Text="{x:Static resources:Resource.SettingsPage_UpdateCheckMiniumTimeSpan_Picker_Minutes}" />
-                <wpfui:NumberBox
-                    Grid.Column="3"
-                    x:Name="_updateCheckMiniumTimeSpanPickerMinutes"
-                    Margin="8,0,0,8"
-                    ClearButtonEnabled="False"
-                    MaxDecimalPlaces="0"
-                    Maximum="59"
-                    Minimum="0"
-                    ValueChanged="UpdateCheckMiniumTimeSpanPickerMinutes_ValueChanged"
-                    Visibility="Hidden" />
-                <TextBlock
-                    Grid.Column="4"
-                    Margin="8,0,0,8"
-                    VerticalAlignment="Center"
-                    Text="{x:Static resources:Resource.SettingsPage_UpdateCheckMiniumTimeSpan_Picker_Seconds}" />
-                <wpfui:NumberBox
-                    Grid.Column="5"
-                    x:Name="_updateCheckMiniumTimeSpanPickerSeconds"
-                    Margin="8,0,0,8"
-                    ClearButtonEnabled="False"
-                    MaxDecimalPlaces="0"
-                    Maximum="59"
-                    Minimum="0"
-                    ValueChanged="UpdateCheckMiniumTimeSpanPickerSeconds_ValueChanged"
-                    Visibility="Hidden" />
-            </Grid>
+            <ComboBox
+                x:Name="_updateCheckFrequencyComboBox"
+                MinWidth="160"
+                Margin="0,0,0,8"
+                AutomationProperties.Name="{x:Static resources:Resource.SettingsPage_UpdateCheckFrequency_Title}"
+                MaxDropDownHeight="Auto"
+                SelectionChanged="UpdateCheckFrequencyComboBox_SelectionChanged"
+                Visibility="Hidden" />
         </custom:CardControl>
 
         <TextBlock