Merge pull request #427 from Flow-Launcher/MigrateDirectPluginJsonStorage

Use API call to save instead of direct call

Author: jjw24

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -51,6 +51,7 @@ public static void Save()
                 var savable = plugin.Plugin as ISavable;
                 savable?.Save();
             }
+            API.SavePluginSettings();
         }
 
         public static async Task ReloadData()

Flow.Launcher.Infrastructure/Storage/FlowLauncherJsonStorage.cs

@@ -8,7 +8,7 @@
 
 namespace Flow.Launcher.Infrastructure.Storage
 {
-    public class FlowLauncherJsonStorage<T> : JsonStrorage<T> where T : new()
+    public class FlowLauncherJsonStorage<T> : JsonStorage<T> where T : new()
     {
         public FlowLauncherJsonStorage()
         {

Flow.Launcher.Infrastructure/Storage/JsonStorage.cs

@@ -9,7 +9,7 @@ namespace Flow.Launcher.Infrastructure.Storage
     /// <summary>
     /// Serialize object using json format.
     /// </summary>
-    public class JsonStrorage<T> where T : new()
+    public class JsonStorage<T> where T : new()
     {
         protected T _data;
         // need a new directory name
@@ -23,10 +23,10 @@ public T Load()
         {
             if (File.Exists(FilePath))
             {
-                var searlized = File.ReadAllText(FilePath);
-                if (!string.IsNullOrWhiteSpace(searlized))
+                var serialized = File.ReadAllText(FilePath);
+                if (!string.IsNullOrWhiteSpace(serialized))
                 {
-                    Deserialize(searlized);
+                    Deserialize(serialized);
                 }
                 else
                 {
@@ -40,16 +40,16 @@ public T Load()
             return _data.NonNull();
         }
 
-        private void Deserialize(string searlized)
+        private void Deserialize(string serialized)
         {
             try
             {
-                _data = JsonSerializer.Deserialize<T>(searlized);
+                _data = JsonSerializer.Deserialize<T>(serialized);
             }
             catch (JsonException e)
             {
                 LoadDefault();
-                Log.Exception($"|JsonStrorage.Deserialize|Deserialize error for json <{FilePath}>", e);
+                Log.Exception($"|JsonStorage.Deserialize|Deserialize error for json <{FilePath}>", e);
             }
 
             if (_data == null)

Flow.Launcher.Infrastructure/Storage/PluginJsonStorage.cs

@@ -3,13 +3,13 @@
 
 namespace Flow.Launcher.Infrastructure.Storage
 {
-    public class PluginJsonStorage<T> :JsonStrorage<T> where T : new()
+    public class PluginJsonStorage<T> :JsonStorage<T> where T : new()
     {
         public PluginJsonStorage()
         {
-            // C# releated, add python releated below
+            // C# related, add python related below
             var dataType = typeof(T);
-            var assemblyName = typeof(T).Assembly.GetName().Name;
+            var assemblyName = dataType.Assembly.GetName().Name;
             DirectoryPath = Path.Combine(DataLocation.DataDirectory(), DirectoryName, Constant.Plugins, assemblyName);
             Helper.ValidateDirectory(DirectoryPath);
 

Flow.Launcher.Plugin/IPublicAPI.cs

@@ -30,10 +30,15 @@ public interface IPublicAPI
         void RestartApp();
 
         /// <summary>
-        /// Save all Flow Launcher settings
+        /// Save everything, all of Flow Launcher and plugins' data and settings
         /// </summary>
         void SaveAppAllSettings();
 
+        /// <summary>
+        /// Save all Flow's plugins settings
+        /// </summary>
+        void SavePluginSettings();
+
         /// <summary>
         /// Reloads any Plugins that have the 
         /// IReloadable implemented. It refeshes
@@ -165,33 +170,20 @@ public interface IPublicAPI
         void LogException(string className, string message, Exception e, [CallerMemberName] string methodName = "");
 
         /// <summary>
-        /// Load JsonStorage for current plugin. This is the method used to load settings from json in Flow
+        /// Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow.
+        /// When the file is not exist, it will create a new instance for the specific type.
         /// </summary>
         /// <typeparam name="T">Type for deserialization</typeparam>
         /// <returns></returns>
-        T LoadJsonStorage<T>() where T : new();
+        T LoadSettingJsonStorage<T>() where T : new();
 
         /// <summary>
-        /// Save JsonStorage for current plugin. This is the method used to save settings to json in Flow.Launcher
+        /// Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher
         /// This method will save the original instance loaded with LoadJsonStorage.
+        /// This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously.
         /// </summary>
         /// <typeparam name="T">Type for Serialization</typeparam>
         /// <returns></returns>
-        void SaveJsonStorage<T>() where T : new();
-
-        /// <summary>
-        /// Save JsonStorage for current plugin. This is the method used to save settings to json in Flow.Launcher
-        /// This method will override the original class instance loaded from LoadJsonStorage
-        /// </summary>
-        /// <typeparam name="T">Type for Serialization</typeparam>
-        /// <returns></returns>
-        void SaveJsonStorage<T>(T settings) where T : new();
-
-        /// <summary>
-        /// Backup the JsonStorage you loaded from LoadJsonStorage
-        /// </summary>
-        /// <typeparam name="T"></typeparam>
-        /// <param name="settings"></param>
-        void BackupJsonStorage<T>() where T : new();
+        void SaveSettingJsonStorage<T>() where T : new();
     }
 }

Flow.Launcher.Plugin/Interfaces/ISavable.cs

@@ -1,8 +1,9 @@
 namespace Flow.Launcher.Plugin
 {
     /// <summary>
-    /// Save plugin settings/cache, 
-    /// todo should be merged into a abstract class intead of seperate interface
+    /// Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved,
+    /// Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded,
+    /// plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow
     /// </summary>
     public interface ISavable
     {

Flow.Launcher/PublicAPIInstance.cs

@@ -76,23 +76,25 @@ public void RestartApp()
 
         public void SaveAppAllSettings()
         {
+            SavePluginSettings();
             _mainVM.Save();
             _settingsVM.Save();
-            PluginManager.Save();
             ImageLoader.Save();
         }
 
         public Task ReloadAllPluginData() => PluginManager.ReloadData();
 
-        public void ShowMsgError(string title, string subTitle = "") => ShowMsg(title, subTitle, Constant.ErrorIcon, true);
+        public void ShowMsgError(string title, string subTitle = "") =>
+            ShowMsg(title, subTitle, Constant.ErrorIcon, true);
 
-        public void ShowMsg(string title, string subTitle = "", string iconPath = "") => ShowMsg(title, subTitle, iconPath, true);
+        public void ShowMsg(string title, string subTitle = "", string iconPath = "") =>
+            ShowMsg(title, subTitle, iconPath, true);
 
         public void ShowMsg(string title, string subTitle, string iconPath, bool useMainWindowAsOwner = true)
         {
             Application.Current.Dispatcher.Invoke(() =>
             {
-                var msg = useMainWindowAsOwner ? new Msg { Owner = Application.Current.MainWindow } : new Msg();
+                var msg = useMainWindowAsOwner ? new Msg {Owner = Application.Current.MainWindow} : new Msg();
                 msg.Show(title, subTitle, iconPath);
             });
         }
@@ -113,61 +115,70 @@ public void OpenSettingDialog()
 
         public List<PluginPair> GetAllPlugins() => PluginManager.AllPlugins.ToList();
 
-        public MatchResult FuzzySearch(string query, string stringToCompare) => StringMatcher.FuzzySearch(query, stringToCompare);
+        public MatchResult FuzzySearch(string query, string stringToCompare) =>
+            StringMatcher.FuzzySearch(query, stringToCompare);
 
         public Task<string> HttpGetStringAsync(string url, CancellationToken token = default) => Http.GetAsync(url);
 
-        public Task<Stream> HttpGetStreamAsync(string url, CancellationToken token = default) => Http.GetStreamAsync(url);
+        public Task<Stream> HttpGetStreamAsync(string url, CancellationToken token = default) =>
+            Http.GetStreamAsync(url);
 
-        public Task HttpDownloadAsync([NotNull] string url, [NotNull] string filePath, CancellationToken token = default) => Http.DownloadAsync(url, filePath, token);
+        public Task HttpDownloadAsync([NotNull] string url, [NotNull] string filePath,
+            CancellationToken token = default) => Http.DownloadAsync(url, filePath, token);
 
-        public void AddActionKeyword(string pluginId, string newActionKeyword) => PluginManager.AddActionKeyword(pluginId, newActionKeyword);
+        public void AddActionKeyword(string pluginId, string newActionKeyword) =>
+            PluginManager.AddActionKeyword(pluginId, newActionKeyword);
 
-        public void RemoveActionKeyword(string pluginId, string oldActionKeyword) => PluginManager.RemoveActionKeyword(pluginId, oldActionKeyword);
+        public void RemoveActionKeyword(string pluginId, string oldActionKeyword) =>
+            PluginManager.RemoveActionKeyword(pluginId, oldActionKeyword);
 
-        public void LogDebug(string className, string message, [CallerMemberName] string methodName = "") => Log.Debug(className, message, methodName);
+        public void LogDebug(string className, string message, [CallerMemberName] string methodName = "") =>
+            Log.Debug(className, message, methodName);
 
-        public void LogInfo(string className, string message, [CallerMemberName] string methodName = "") => Log.Info(className, message, methodName);
+        public void LogInfo(string className, string message, [CallerMemberName] string methodName = "") =>
+            Log.Info(className, message, methodName);
 
-        public void LogWarn(string className, string message, [CallerMemberName] string methodName = "") => Log.Warn(className, message, methodName);
+        public void LogWarn(string className, string message, [CallerMemberName] string methodName = "") =>
+            Log.Warn(className, message, methodName);
 
-        public void LogException(string className, string message, Exception e, [CallerMemberName] string methodName = "") => Log.Exception(className, message, e, methodName);
+        public void LogException(string className, string message, Exception e,
+            [CallerMemberName] string methodName = "") => Log.Exception(className, message, e, methodName);
 
-        private readonly Dictionary<Type, dynamic> PluginJsonStorages = new Dictionary<Type, dynamic>();
+        private readonly Dictionary<Type, object> _pluginJsonStorages = new();
 
-        public T LoadJsonStorage<T>() where T : new()
+        public void SavePluginSettings()
         {
-            var type = typeof(T);
-            if (!PluginJsonStorages.ContainsKey(type))
-                PluginJsonStorages[type] = new PluginJsonStorage<T>();
-
-            return PluginJsonStorages[type].Load();
+            foreach (var value in _pluginJsonStorages.Values)
+            {
+                var method = value.GetType().GetMethod("Save");
+                method?.Invoke(value, null);
+            }
         }
 
-        public void SaveJsonStorage<T>() where T : new()
+        public T LoadSettingJsonStorage<T>() where T : new()
         {
             var type = typeof(T);
-            if (!PluginJsonStorages.ContainsKey(type))
-                PluginJsonStorages[type] = new PluginJsonStorage<T>();
+            if (!_pluginJsonStorages.ContainsKey(type))
+                _pluginJsonStorages[type] = new PluginJsonStorage<T>();
 
-            PluginJsonStorages[type].Save();
+            return ((PluginJsonStorage<T>) _pluginJsonStorages[type]).Load();
         }
 
-        public void SaveJsonStorage<T>(T settings) where T : new()
+        public void SaveSettingJsonStorage<T>() where T : new()
         {
             var type = typeof(T);
-            PluginJsonStorages[type] = new PluginJsonStorage<T>(settings);
+            if (!_pluginJsonStorages.ContainsKey(type))
+                _pluginJsonStorages[type] = new PluginJsonStorage<T>();
 
-            PluginJsonStorages[type].Save();
+            ((PluginJsonStorage<T>) _pluginJsonStorages[type]).Save();
         }
 
-        public void BackupJsonStorage<T>() where T : new()
+        public void SaveJsonStorage<T>(T settings) where T : new()
         {
             var type = typeof(T);
-            if (!PluginJsonStorages.ContainsKey(type))
-                throw new InvalidOperationException("You haven't registered the JsonStorage for specific Type");
+            _pluginJsonStorages[type] = new PluginJsonStorage<T>(settings);
 
-            PluginJsonStorages[type].BackupOriginFile();
+            ((PluginJsonStorage<T>) _pluginJsonStorages[type]).Save();
         }
 
         public event FlowLauncherGlobalKeyboardEventHandler GlobalKeyboardEvent;
@@ -180,11 +191,12 @@ private bool KListener_hookedKeyboardCallback(KeyEvent keyevent, int vkcode, Spe
         {
             if (GlobalKeyboardEvent != null)
             {
-                return GlobalKeyboardEvent((int)keyevent, vkcode, state);
+                return GlobalKeyboardEvent((int) keyevent, vkcode, state);
             }
+
             return true;
         }
 
         #endregion
     }
-}
+}

Plugins/Flow.Launcher.Plugin.BrowserBookmark/Main.cs

@@ -12,21 +12,19 @@
 
 namespace Flow.Launcher.Plugin.BrowserBookmark
 {
-    public class Main : ISettingProvider, IPlugin, IReloadable, IPluginI18n, ISavable, IContextMenu
+    public class Main : ISettingProvider, IPlugin, IReloadable, IPluginI18n, IContextMenu
     {
         private PluginInitContext context;
 
         private List<Bookmark> cachedBookmarks = new List<Bookmark>();
 
         private Settings _settings { get; set;}
-        private PluginJsonStorage<Settings> _storage { get; set;}
 
         public void Init(PluginInitContext context)
         {
             this.context = context;
 
-            _storage = new PluginJsonStorage<Settings>();
-            _settings = _storage.Load();
+            _settings = context.API.LoadSettingJsonStorage<Settings>();
 
             cachedBookmarks = Bookmarks.LoadAllBookmarks();
         }
@@ -113,11 +111,6 @@ public Control CreateSettingPanel()
             return new SettingsControl(_settings);
         }
 
-        public void Save()
-        {
-            _storage.Save();
-        }
-
         public List<Result> LoadContextMenus(Result selectedResult)
         {
             return new List<Result>() {

Plugins/Flow.Launcher.Plugin.BrowserBookmark/plugin.json

@@ -4,7 +4,7 @@
   "Name": "Browser Bookmarks",
   "Description": "Search your browser bookmarks",
   "Author": "qianlifeng, Ioannis G.",
-  "Version": "1.4.3",
+  "Version": "1.4.4",
   "Language": "csharp",
   "Website": "https://github.com/Flow-Launcher/Flow.Launcher",
   "ExecuteFileName": "Flow.Launcher.Plugin.BrowserBookmark.dll",

Plugins/Flow.Launcher.Plugin.Calculator/Main.cs

@@ -12,7 +12,7 @@
 
 namespace Flow.Launcher.Plugin.Caculator
 {
-    public class Main : IPlugin, IPluginI18n, ISavable, ISettingProvider
+    public class Main : IPlugin, IPluginI18n, ISettingProvider
     {
         private static readonly Regex RegValidExpressChar = new Regex(
                         @"^(" +
@@ -30,17 +30,11 @@ public class Main : IPlugin, IPluginI18n, ISavable, ISettingProvider
         private static Settings _settings;
         private static SettingsViewModel _viewModel;
 
-        static Main()
-        {
-            
-        }
-
         public void Init(PluginInitContext context)
         {
             Context = context;
-
-            _viewModel = new SettingsViewModel();
-            _settings = _viewModel.Settings;
+            _settings = context.API.LoadSettingJsonStorage<Settings>();
+            _viewModel = new SettingsViewModel(_settings);
 
             MagesEngine = new Engine(new Configuration
             {
@@ -187,10 +181,5 @@ public Control CreateSettingPanel()
         {
             return new CalculatorSettings(_viewModel);
         }
-
-        public void Save()
-        {
-            _viewModel.Save();
-        }
     }
 }