Check if plugin has been modified when installing/updating/uninstalling

VictoriousRaptor · VictoriousRaptor · commit 69dad1be6c2b · 2023-11-11T15:05:24.000+08:00
diff --git a/Flow.Launcher.Core/Plugin/PluginManager.cs b/Flow.Launcher.Core/Plugin/PluginManager.cs
@@ -31,6 +31,7 @@ public static class PluginManager
 
         private static PluginsSettings Settings;
         private static List<PluginMetadata> _metadatas;
+        private static List<string> _modifiedPlugins = new List<string>();
 
         /// <summary>
         /// Directories that will hold Flow Launcher plugin directory
@@ -358,8 +359,42 @@ private static bool SameOrLesserPluginVersionExists(string metadataPath)
                           && newMetadata.Version.CompareTo(x.Metadata.Version) <= 0);
         }
 
-        public static void Install(UserPlugin plugin, string downloadedFilePath)
+        #region Public functions
+
+        public static bool PluginModified(string uuid)
+        {
+            return _modifiedPlugins.Contains(uuid);
+        }
+
+        public static void UpdatePlugin(PluginMetadata existingVersion, UserPlugin newVersion, string downloadedFilePath)
+        {
+            InstallPlugin(newVersion, downloadedFilePath, checkModified:false);
+            UninstallPlugin(existingVersion, removeSettings:false, checkModified:false);
+            _modifiedPlugins.Add(existingVersion.ID);
+        }
+
+        public static void InstallPlugin(UserPlugin plugin, string downloadedFilePath)
+        {
+            InstallPlugin(plugin, downloadedFilePath, true);
+        }
+
+        public static void UninstallPlugin(PluginMetadata plugin, bool removeSettings = true)
+        {
+            UninstallPlugin(plugin, removeSettings, true);
+        }
+
+        #endregion
+
+        #region Internal functions
+
+        internal static void InstallPlugin(UserPlugin plugin, string downloadedFilePath, bool checkModified)
         {
+            if (checkModified && PluginModified(plugin.ID))
+            {
+                // Distinguish exception from installing same or less version
+                throw new ArgumentException($"Plugin {plugin.Name} {plugin.ID} has been modified.", nameof(plugin));
+            }
+
             var tempFolderPath = Path.Combine(Path.GetTempPath(), "flowlauncher");
             var tempFolderPluginPath = Path.Combine(tempFolderPath, "plugin");
 
@@ -420,10 +455,20 @@ public static void Install(UserPlugin plugin, string downloadedFilePath)
             FilesFolders.CopyAll(pluginFolderPath, newPluginPath);
 
             Directory.Delete(pluginFolderPath, true);
+
+            if (checkModified)
+            {
+                _modifiedPlugins.Add(plugin.ID);
+            }
         }
 
-        public static void Uninstall(PluginMetadata plugin, bool removeSettings = true)
+        internal static void UninstallPlugin(PluginMetadata plugin, bool removeSettings, bool checkModified)
         {
+            if (checkModified && PluginModified(plugin.ID))
+            {
+                throw new ArgumentException($"Plugin {plugin.Name} has been modified");
+            }
+
             if (removeSettings)
             {
                 Settings.Plugins.Remove(plugin.ID);
@@ -432,6 +477,13 @@ public static void Uninstall(PluginMetadata plugin, bool removeSettings = true)
 
             // Marked for deletion. Will be deleted on next start up
             using var _ = File.CreateText(Path.Combine(plugin.PluginDirectory, "NeedDelete.txt"));
+
+            if (checkModified)
+            {
+                _modifiedPlugins.Add(plugin.ID);
+            }
         }
+
+        #endregion
     }
 }
diff --git a/Plugins/Flow.Launcher.Plugin.PluginsManager/Languages/en.xaml b/Plugins/Flow.Launcher.Plugin.PluginsManager/Languages/en.xaml
@@ -20,6 +20,7 @@
     <system:String x:Key="plugin_pluginsmanager_install_error_duplicate">Error: A plugin which has the same or greater version with {0} already exists.</system:String>
     <system:String x:Key="plugin_pluginsmanager_install_error_title">Error installing plugin</system:String>
     <system:String x:Key="plugin_pluginsmanager_install_error_subtitle">Error occurred while trying to install {0}</system:String>
+    <system:String x:Key="plugin_pluginsmanager_uninstall_error_title">Error uninstalling plugin</system:String>
     <system:String x:Key="plugin_pluginsmanager_update_noresult_title">No update available</system:String>
     <system:String x:Key="plugin_pluginsmanager_update_noresult_subtitle">All plugins are up to date</system:String>
     <system:String x:Key="plugin_pluginsmanager_update_prompt">{0} by {1} {2}{3}Would you like to update this plugin? After the update Flow will automatically restart.</system:String>
@@ -36,7 +37,8 @@
     <system:String x:Key="plugin_pluginsmanager_install_success_no_restart">Plugin {0} successfully installed. Please restart Flow.</system:String>
     <system:String x:Key="plugin_pluginsmanager_uninstall_success_no_restart">Plugin {0} successfully uninstalled. Please restart Flow.</system:String>
     <system:String x:Key="plugin_pluginsmanager_update_success_no_restart">Plugin {0} successfully updated. Please restart Flow.</system:String>
-
+    <system:String x:Key="plugin_pluginsmanager_plugin_modified_error">Plugin {0} has already been modified. Please restart Flow before making any further changes.</system:String>
+   
     <!--  Plugin Infos  -->
     <system:String x:Key="plugin_pluginsmanager_plugin_name">Plugins Manager</system:String>
     <system:String x:Key="plugin_pluginsmanager_plugin_description">Management of installing, uninstalling or updating Flow Launcher plugins</system:String>
diff --git a/Plugins/Flow.Launcher.Plugin.PluginsManager/PluginsManager.cs b/Plugins/Flow.Launcher.Plugin.PluginsManager/PluginsManager.cs
@@ -239,8 +239,6 @@ where existingPlugin.Metadata.Version.CompareTo(pluginFromManifest.Version) <
                                     Context.API.GetTranslation("plugin_pluginsmanager_update_title"),
                                     MessageBoxButton.YesNo) == MessageBoxResult.Yes)
                             {
-                                Uninstall(x.PluginExistingMetadata, false);
-
                                 var downloadToFilePath = Path.Combine(DataLocation.PluginsDirectory,
                                     $"{x.Name}-{x.NewVersion}.zip");
 
@@ -249,7 +247,7 @@ where existingPlugin.Metadata.Version.CompareTo(pluginFromManifest.Version) <
                                     await Http.DownloadAsync(x.PluginNewUserPlugin.UrlDownload, downloadToFilePath)
                                         .ConfigureAwait(false);
 
-                                    Install(x.PluginNewUserPlugin, downloadToFilePath);
+                                    PluginManager.UpdatePlugin(x.PluginExistingMetadata, x.PluginNewUserPlugin, downloadToFilePath);
 
                                     if (Settings.AutoRestartAfterChanging)
                                     {
@@ -413,19 +411,24 @@ private void Install(UserPlugin plugin, string downloadedFilePath)
                 throw new FileNotFoundException($"Plugin {plugin.ID} zip file not found at {downloadedFilePath}", downloadedFilePath);
             try
             {
-                PluginManager.Install(plugin, downloadedFilePath);
+                PluginManager.InstallPlugin(plugin, downloadedFilePath);
             }
-            catch(FileNotFoundException e)
+            catch (FileNotFoundException e)
             {
+                Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"),
+                                         Context.API.GetTranslation("plugin_pluginsmanager_install_errormetadatafile"));
                 Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);
-                MessageBox.Show(Context.API.GetTranslation("plugin_pluginsmanager_install_errormetadatafile"),
-                                Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"));
             }
-            catch(InvalidOperationException e)
+            catch (InvalidOperationException e)
             {
+                Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"),
+                                         string.Format(Context.API.GetTranslation("plugin_pluginsmanager_install_error_duplicate"), plugin.Name));
+                Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);
+            }
+            catch (ArgumentException e) {
+                Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"),
+                                         string.Format(Context.API.GetTranslation("plugin_pluginsmanager_plugin_modified_error"), plugin.Name));
                 Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);
-                MessageBox.Show(string.Format(Context.API.GetTranslation("plugin_pluginsmanager_install_error_duplicate"), plugin.Name),
-                                Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"));
             }
         }
 
@@ -482,9 +485,18 @@ internal List<Result> RequestUninstall(string search)
             return Search(results, search);
         }
 
-        private static void Uninstall(PluginMetadata plugin, bool removeSettings = true)
+        private void Uninstall(PluginMetadata plugin)
         {
-            PluginManager.Uninstall(plugin, removeSettings);
+            try
+            {
+                PluginManager.UninstallPlugin(plugin, removeSettings:true);
+            }
+            catch (ArgumentException e)
+            {
+                Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);
+                Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_uninstall_error_title"),
+                                         Context.API.GetTranslation("plugin_pluginsmanager_plugin_modified_error"));
+            }
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -239,8 +239,6 @@ where existingPlugin.Metadata.Version.CompareTo(pluginFromManifest.Version) <`
`239`	`239`	`Context.API.GetTranslation("plugin_pluginsmanager_update_title"),`
`240`	`240`	`MessageBoxButton.YesNo) == MessageBoxResult.Yes)`
`241`	`241`	`{`
`242`		`- Uninstall(x.PluginExistingMetadata, false);`
`243`		`-`
`244`	`242`	`var downloadToFilePath = Path.Combine(DataLocation.PluginsDirectory,`
`245`	`243`	`$"{x.Name}-{x.NewVersion}.zip");`
`246`	`244`
`@@ -249,7 +247,7 @@ where existingPlugin.Metadata.Version.CompareTo(pluginFromManifest.Version) <`
`249`	`247`	`await Http.DownloadAsync(x.PluginNewUserPlugin.UrlDownload, downloadToFilePath)`
`250`	`248`	`.ConfigureAwait(false);`
`251`	`249`
`252`		`- Install(x.PluginNewUserPlugin, downloadToFilePath);`
	`250`	`+ PluginManager.UpdatePlugin(x.PluginExistingMetadata, x.PluginNewUserPlugin, downloadToFilePath);`
`253`	`251`
`254`	`252`	`if (Settings.AutoRestartAfterChanging)`
`255`	`253`	`{`
`@@ -413,19 +411,24 @@ private void Install(UserPlugin plugin, string downloadedFilePath)`
`413`	`411`	`throw new FileNotFoundException($"Plugin {plugin.ID} zip file not found at {downloadedFilePath}", downloadedFilePath);`
`414`	`412`	`try`
`415`	`413`	`{`
`416`		`- PluginManager.Install(plugin, downloadedFilePath);`
	`414`	`+ PluginManager.InstallPlugin(plugin, downloadedFilePath);`
`417`	`415`	`}`
`418`		`- catch(FileNotFoundException e)`
	`416`	`+ catch (FileNotFoundException e)`
`419`	`417`	`{`
	`418`	`+ Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"),`
	`419`	`+ Context.API.GetTranslation("plugin_pluginsmanager_install_errormetadatafile"));`
`420`	`420`	`Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);`
`421`		`- MessageBox.Show(Context.API.GetTranslation("plugin_pluginsmanager_install_errormetadatafile"),`
`422`		`- Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"));`
`423`	`421`	`}`
`424`		`- catch(InvalidOperationException e)`
	`422`	`+ catch (InvalidOperationException e)`
`425`	`423`	`{`
	`424`	`+ Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"),`
	`425`	`+ string.Format(Context.API.GetTranslation("plugin_pluginsmanager_install_error_duplicate"), plugin.Name));`
	`426`	`+ Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);`
	`427`	`+ }`
	`428`	`+ catch (ArgumentException e) {`
	`429`	`+ Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"),`
	`430`	`+ string.Format(Context.API.GetTranslation("plugin_pluginsmanager_plugin_modified_error"), plugin.Name));`
`426`	`431`	`Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);`
`427`		`- MessageBox.Show(string.Format(Context.API.GetTranslation("plugin_pluginsmanager_install_error_duplicate"), plugin.Name),`
`428`		`- Context.API.GetTranslation("plugin_pluginsmanager_install_error_title"));`
`429`	`432`	`}`
`430`	`433`	`}`
`431`	`434`
`@@ -482,9 +485,18 @@ internal List<Result> RequestUninstall(string search)`
`482`	`485`	`return Search(results, search);`
`483`	`486`	`}`
`484`	`487`
`485`		`- private static void Uninstall(PluginMetadata plugin, bool removeSettings = true)`
	`488`	`+ private void Uninstall(PluginMetadata plugin)`
`486`	`489`	`{`
`487`		`- PluginManager.Uninstall(plugin, removeSettings);`
	`490`	`+ try`
	`491`	`+ {`
	`492`	`+ PluginManager.UninstallPlugin(plugin, removeSettings:true);`
	`493`	`+ }`
	`494`	`+ catch (ArgumentException e)`
	`495`	`+ {`
	`496`	`+ Log.Exception("Flow.Launcher.Plugin.PluginsManager", e.Message, e);`
	`497`	`+ Context.API.ShowMsgError(Context.API.GetTranslation("plugin_pluginsmanager_uninstall_error_title"),`
	`498`	`+ Context.API.GetTranslation("plugin_pluginsmanager_plugin_modified_error"));`
	`499`	`+ }`
`488`	`500`	`}`
`489`	`501`	`}`
`490`	`502`	`}`