Merge pull request #3413 from Jack251970/infrusture_helper

Jack251970 · web-flow · commit 3771d642602e · 2025-04-04T11:40:52.000+08:00
New API Function ValidateDirectory and ValidateDataDirectory &amp; Cleanup Helper.cs in Flow.Launcher.Infrastructure project
diff --git a/Flow.Launcher.Core/Updater.cs b/Flow.Launcher.Core/Updater.cs
@@ -17,6 +17,7 @@
 using Flow.Launcher.Plugin;
 using System.Text.Json.Serialization;
 using System.Threading;
+using System.Text.Json;
 
 namespace Flow.Launcher.Core
 {
@@ -51,7 +52,7 @@ public async Task UpdateAppAsync(bool silentUpdate = true)
                 var newReleaseVersion = Version.Parse(newUpdateInfo.FutureReleaseEntry.Version.ToString());
                 var currentVersion = Version.Parse(Constant.Version);
 
-                Log.Info($"|Updater.UpdateApp|Future Release <{newUpdateInfo.FutureReleaseEntry.Formatted()}>");
+                Log.Info($"|Updater.UpdateApp|Future Release <{Formatted(newUpdateInfo.FutureReleaseEntry)}>");
 
                 if (newReleaseVersion <= currentVersion)
                 {
@@ -151,5 +152,15 @@ public string NewVersionTips(string version)
 
             return tips;
         }
+
+        private static string Formatted<T>(T t)
+        {
+            var formatted = JsonSerializer.Serialize(t, new JsonSerializerOptions
+            {
+                WriteIndented = true
+            });
+
+            return formatted;
+        }
     }
 }
diff --git a/Flow.Launcher.Infrastructure/Helper.cs b/Flow.Launcher.Infrastructure/Helper.cs
@@ -1,19 +1,11 @@
 ﻿#nullable enable
 
 using System;
-using System.IO;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 
 namespace Flow.Launcher.Infrastructure
 {
     public static class Helper
     {
-        static Helper()
-        {
-            jsonFormattedSerializerOptions.Converters.Add(new JsonStringEnumConverter());
-        }
-
         /// <summary>
         /// http://www.yinwang.org/blog-cn/2015/11/21/programming-philosophy
         /// </summary>
@@ -36,55 +28,5 @@ public static void RequireNonNull<T>(this T obj)
                 throw new NullReferenceException();
             }
         }
-
-        public static void ValidateDataDirectory(string bundledDataDirectory, string dataDirectory)
-        {
-            if (!Directory.Exists(dataDirectory))
-            {
-                Directory.CreateDirectory(dataDirectory);
-            }
-
-            foreach (var bundledDataPath in Directory.GetFiles(bundledDataDirectory))
-            {
-                var data = Path.GetFileName(bundledDataPath);
-                var dataPath = Path.Combine(dataDirectory, data.NonNull());
-                if (!File.Exists(dataPath))
-                {
-                    File.Copy(bundledDataPath, dataPath);
-                }
-                else
-                {
-                    var time1 = new FileInfo(bundledDataPath).LastWriteTimeUtc;
-                    var time2 = new FileInfo(dataPath).LastWriteTimeUtc;
-                    if (time1 != time2)
-                    {
-                        File.Copy(bundledDataPath, dataPath, true);
-                    }
-                }
-            }
-        }
-
-        public static void ValidateDirectory(string path)
-        {
-            if (!Directory.Exists(path))
-            {
-                Directory.CreateDirectory(path);
-            }
-        }
-
-        private static readonly JsonSerializerOptions jsonFormattedSerializerOptions = new JsonSerializerOptions
-        {
-            WriteIndented = true
-        };
-
-        public static string Formatted<T>(this T t)
-        {
-            var formatted = JsonSerializer.Serialize(t, new JsonSerializerOptions
-            {
-                WriteIndented = true
-            });
-
-            return formatted;
-        }
     }
 }
diff --git a/Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs b/Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs
@@ -2,6 +2,7 @@
 using System.Threading.Tasks;
 using Flow.Launcher.Infrastructure.Logger;
 using Flow.Launcher.Infrastructure.UserSettings;
+using Flow.Launcher.Plugin.SharedCommands;
 using MemoryPack;
 
 namespace Flow.Launcher.Infrastructure.Storage
@@ -21,7 +22,7 @@ public class BinaryStorage<T>
         public BinaryStorage(string filename, string directoryPath = null)
         {
             directoryPath ??= DataLocation.CacheDirectory;
-            Helper.ValidateDirectory(directoryPath);
+            FilesFolders.ValidateDirectory(directoryPath);
 
             FilePath = Path.Combine(directoryPath, $"{filename}{FileSuffix}");
         }
diff --git a/Flow.Launcher.Infrastructure/Storage/FlowLauncherJsonStorage.cs b/Flow.Launcher.Infrastructure/Storage/FlowLauncherJsonStorage.cs
@@ -1,5 +1,6 @@
 ﻿using System.IO;
 using Flow.Launcher.Infrastructure.UserSettings;
+using Flow.Launcher.Plugin.SharedCommands;
 
 namespace Flow.Launcher.Infrastructure.Storage
 {
@@ -8,10 +9,10 @@ namespace Flow.Launcher.Infrastructure.Storage
         public FlowLauncherJsonStorage()
         {
             var directoryPath = Path.Combine(DataLocation.DataDirectory(), DirectoryName);
-            Helper.ValidateDirectory(directoryPath);
+            FilesFolders.ValidateDirectory(directoryPath);
 
             var filename = typeof(T).Name;
             FilePath = Path.Combine(directoryPath, $"{filename}{FileSuffix}");
         }
     }
-}
+}
diff --git a/Flow.Launcher.Infrastructure/Storage/JsonStorage.cs b/Flow.Launcher.Infrastructure/Storage/JsonStorage.cs
@@ -5,6 +5,7 @@
 using System.Text.Json;
 using System.Threading.Tasks;
 using Flow.Launcher.Infrastructure.Logger;
+using Flow.Launcher.Plugin.SharedCommands;
 
 namespace Flow.Launcher.Infrastructure.Storage
 {
@@ -37,7 +38,7 @@ public JsonStorage(string filePath)
             FilePath = filePath;
             DirectoryPath = Path.GetDirectoryName(filePath) ?? throw new ArgumentException("Invalid file path");
 
-            Helper.ValidateDirectory(DirectoryPath);
+            FilesFolders.ValidateDirectory(DirectoryPath);
         }
 
         public async Task<T> LoadAsync()
diff --git a/Flow.Launcher.Infrastructure/Storage/PluginJsonStorage.cs b/Flow.Launcher.Infrastructure/Storage/PluginJsonStorage.cs
@@ -1,5 +1,6 @@
 ﻿using System.IO;
 using Flow.Launcher.Infrastructure.UserSettings;
+using Flow.Launcher.Plugin.SharedCommands;
 
 namespace Flow.Launcher.Infrastructure.Storage
 {
@@ -14,7 +15,7 @@ public PluginJsonStorage()
             var dataType = typeof(T);
             AssemblyName = dataType.Assembly.GetName().Name;
             DirectoryPath = Path.Combine(DataLocation.PluginSettingsDirectory, AssemblyName);
-            Helper.ValidateDirectory(DirectoryPath);
+            FilesFolders.ValidateDirectory(DirectoryPath);
 
             FilePath = Path.Combine(DirectoryPath, $"{dataType.Name}{FileSuffix}");
         }
diff --git a/Flow.Launcher.Plugin/SharedCommands/FilesFolders.cs b/Flow.Launcher.Plugin/SharedCommands/FilesFolders.cs
@@ -318,5 +318,51 @@ public static string EnsureTrailingSlash(this string path)
         {
             return path.TrimEnd(Path.DirectorySeparatorChar) + Path.DirectorySeparatorChar;
         }
+
+        /// <summary>
+        /// Validates a directory, creating it if it doesn't exist
+        /// </summary>
+        /// <param name="path"></param>
+        public static void ValidateDirectory(string path)
+        {
+            if (!Directory.Exists(path))
+            {
+                Directory.CreateDirectory(path);
+            }
+        }
+
+        /// <summary>
+        /// Validates a data directory, synchronizing it by ensuring all files from a bundled source directory exist in it.
+        /// If files are missing or outdated, they are copied from the bundled directory to the data directory.
+        /// </summary>
+        /// <param name="bundledDataDirectory"></param>
+        /// <param name="dataDirectory"></param>
+        public static void ValidateDataDirectory(string bundledDataDirectory, string dataDirectory)
+        {
+            if (!Directory.Exists(dataDirectory))
+            {
+                Directory.CreateDirectory(dataDirectory);
+            }
+
+            foreach (var bundledDataPath in Directory.GetFiles(bundledDataDirectory))
+            {
+                var data = Path.GetFileName(bundledDataPath);
+                if (data == null) continue;
+                var dataPath = Path.Combine(dataDirectory, data);
+                if (!File.Exists(dataPath))
+                {
+                    File.Copy(bundledDataPath, dataPath);
+                }
+                else
+                {
+                    var time1 = new FileInfo(bundledDataPath).LastWriteTimeUtc;
+                    var time2 = new FileInfo(dataPath).LastWriteTimeUtc;
+                    if (time1 != time2)
+                    {
+                        File.Copy(bundledDataPath, dataPath, true);
+                    }
+                }
+            }
+        }
     }
 }
diff --git a/Plugins/Flow.Launcher.Plugin.Program/Main.cs b/Plugins/Flow.Launcher.Plugin.Program/Main.cs
@@ -6,13 +6,13 @@
 using System.Threading;
 using System.Threading.Tasks;
 using System.Windows.Controls;
-using Flow.Launcher.Infrastructure;
 using Flow.Launcher.Infrastructure.Logger;
 using Flow.Launcher.Infrastructure.Storage;
 using Flow.Launcher.Infrastructure.UserSettings;
 using Flow.Launcher.Plugin.Program.Programs;
 using Flow.Launcher.Plugin.Program.Views;
 using Flow.Launcher.Plugin.Program.Views.Models;
+using Flow.Launcher.Plugin.SharedCommands;
 using Microsoft.Extensions.Caching.Memory;
 using Path = System.IO.Path;
 using Stopwatch = Flow.Launcher.Infrastructure.Stopwatch;
@@ -191,7 +191,7 @@ public async Task InitAsync(PluginInitContext context)
 
             await Stopwatch.NormalAsync("|Flow.Launcher.Plugin.Program.Main|Preload programs cost", async () =>
             {
-                Helper.ValidateDirectory(Context.CurrentPluginMetadata.PluginCacheDirectoryPath);
+                FilesFolders.ValidateDirectory(Context.CurrentPluginMetadata.PluginCacheDirectoryPath);
 
                 static void MoveFile(string sourcePath, string destinationPath)
                 {
diff --git a/Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs b/Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs
@@ -5,7 +5,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using System.Windows.Controls;
-using Flow.Launcher.Infrastructure;
 using Flow.Launcher.Plugin.SharedCommands;
 
 namespace Flow.Launcher.Plugin.WebSearch
@@ -180,7 +179,7 @@ void Init()
 
                 // Default images directory is in the WebSearch's application folder  
                 DefaultImagesDirectory = Path.Combine(pluginDirectory, Images);
-                Helper.ValidateDataDirectory(bundledImagesDirectory, DefaultImagesDirectory);
+                FilesFolders.ValidateDataDirectory(bundledImagesDirectory, DefaultImagesDirectory);
 
                 // Custom images directory is in the WebSearch's data location folder
                 CustomImagesDirectory = Path.Combine(_context.CurrentPluginMetadata.PluginSettingsDirectoryPath, "CustomIcons");

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`using Flow.Launcher.Plugin;`
`18`	`18`	`using System.Text.Json.Serialization;`
`19`	`19`	`using System.Threading;`
	`20`	`+using System.Text.Json;`
`20`	`21`
`21`	`22`	`namespace Flow.Launcher.Core`
`22`	`23`	`{`
`@@ -51,7 +52,7 @@ public async Task UpdateAppAsync(bool silentUpdate = true)`
`51`	`52`	`var newReleaseVersion = Version.Parse(newUpdateInfo.FutureReleaseEntry.Version.ToString());`
`52`	`53`	`var currentVersion = Version.Parse(Constant.Version);`
`53`	`54`
`54`		`- Log.Info($"\|Updater.UpdateApp\|Future Release <{newUpdateInfo.FutureReleaseEntry.Formatted()}>");`
	`55`	`+ Log.Info($"\|Updater.UpdateApp\|Future Release <{Formatted(newUpdateInfo.FutureReleaseEntry)}>");`
`55`	`56`
`56`	`57`	`if (newReleaseVersion <= currentVersion)`
`57`	`58`	`{`
`@@ -151,5 +152,15 @@ public string NewVersionTips(string version)`
`151`	`152`
`152`	`153`	`return tips;`
`153`	`154`	`}`
	`155`	`+`
	`156`	`+ private static string Formatted<T>(T t)`
	`157`	`+ {`
	`158`	`+ var formatted = JsonSerializer.Serialize(t, new JsonSerializerOptions`
	`159`	`+ {`
	`160`	`+ WriteIndented = true`
	`161`	`+ });`
	`162`	`+`
	`163`	`+ return formatted;`
	`164`	`+ }`
`154`	`165`	`}`
`155`	`166`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`using System.Threading.Tasks;`
`3`	`3`	`using Flow.Launcher.Infrastructure.Logger;`
`4`	`4`	`using Flow.Launcher.Infrastructure.UserSettings;`
	`5`	`+using Flow.Launcher.Plugin.SharedCommands;`
`5`	`6`	`using MemoryPack;`
`6`	`7`
`7`	`8`	`namespace Flow.Launcher.Infrastructure.Storage`
`@@ -21,7 +22,7 @@ public class BinaryStorage<T>`
`21`	`22`	`public BinaryStorage(string filename, string directoryPath = null)`
`22`	`23`	`{`
`23`	`24`	`directoryPath ??= DataLocation.CacheDirectory;`
`24`		`- Helper.ValidateDirectory(directoryPath);`
	`25`	`+ FilesFolders.ValidateDirectory(directoryPath);`
`25`	`26`
`26`	`27`	`FilePath = Path.Combine(directoryPath, $"{filename}{FileSuffix}");`
`27`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System.IO;`
`2`	`2`	`using Flow.Launcher.Infrastructure.UserSettings;`
	`3`	`+using Flow.Launcher.Plugin.SharedCommands;`
`3`	`4`
`4`	`5`	`namespace Flow.Launcher.Infrastructure.Storage`
`5`	`6`	`{`
`@@ -8,10 +9,10 @@ namespace Flow.Launcher.Infrastructure.Storage`
`8`	`9`	`public FlowLauncherJsonStorage()`
`9`	`10`	`{`
`10`	`11`	`var directoryPath = Path.Combine(DataLocation.DataDirectory(), DirectoryName);`
`11`		`- Helper.ValidateDirectory(directoryPath);`
	`12`	`+ FilesFolders.ValidateDirectory(directoryPath);`
`12`	`13`
`13`	`14`	`var filename = typeof(T).Name;`
`14`	`15`	`FilePath = Path.Combine(directoryPath, $"{filename}{FileSuffix}");`
`15`	`16`	`}`
`16`	`17`	`}`
`17`		`-}`
	`18`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using System.Text.Json;`
`6`	`6`	`using System.Threading.Tasks;`
`7`	`7`	`using Flow.Launcher.Infrastructure.Logger;`
	`8`	`+using Flow.Launcher.Plugin.SharedCommands;`
`8`	`9`
`9`	`10`	`namespace Flow.Launcher.Infrastructure.Storage`
`10`	`11`	`{`
`@@ -37,7 +38,7 @@ public JsonStorage(string filePath)`
`37`	`38`	`FilePath = filePath;`
`38`	`39`	`DirectoryPath = Path.GetDirectoryName(filePath) ?? throw new ArgumentException("Invalid file path");`
`39`	`40`
`40`		`- Helper.ValidateDirectory(DirectoryPath);`
	`41`	`+ FilesFolders.ValidateDirectory(DirectoryPath);`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`public async Task<T> LoadAsync()`