Merge pull request #4299 from Flow-Launcher/IsMinimumAppVersionSatisfied

Add MinimumAppVersion support for plugin.json

Flow.Launcher.Core/ExternalPlugins/PluginsManifest.cs

@@ -3,7 +3,7 @@ using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
 using Flow.Launcher.Plugin;
-using Flow.Launcher.Infrastructure;
+using Flow.Launcher.Core.Plugin;
 
 namespace Flow.Launcher.Core.ExternalPlugins
 {
@@ -41,11 +41,10 @@ namespace Flow.Launcher.Core.ExternalPlugins
                         return false;
 
                     var updatedPluginResults = new List<UserPlugin>();
-                    var appVersion = SemanticVersioning.Version.Parse(Constant.Version);
                     
                     for (int i = 0; i < results.Count; i++)
                     {
-                        if (IsMinimumAppVersionSatisfied(results[i], appVersion))
+                        if (PluginManager.IsMinimumAppVersionSatisfied(results[i].Name, results[i].MinimumAppVersion))
                             updatedPluginResults.Add(results[i]);
                     }
 
@@ -72,28 +71,5 @@ namespace Flow.Launcher.Core.ExternalPlugins
 
             return false;
         }
-
-        private static bool IsMinimumAppVersionSatisfied(UserPlugin plugin, SemanticVersioning.Version appVersion)
-        {
-            if (string.IsNullOrEmpty(plugin.MinimumAppVersion))
-                return true;
-
-            try
-            {
-                if (appVersion >= SemanticVersioning.Version.Parse(plugin.MinimumAppVersion))
-                    return true;
-            }
-            catch (Exception e)
-            {
-                PublicApi.Instance.LogException(ClassName, $"Failed to parse the minimum app version {plugin.MinimumAppVersion} for plugin {plugin.Name}. "
-                    + "Plugin excluded from manifest", e);
-                return false;
-            }
-
-            PublicApi.Instance.LogInfo(ClassName, $"Plugin {plugin.Name} requires minimum Flow Launcher version {plugin.MinimumAppVersion}, "
-                    + $"but current version is {Constant.Version}. Plugin excluded from manifest.");
-
-            return false;
-        }
     }
 }

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -6,6 +6,7 @@ using System.Linq;
 using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
+using System.Windows;
 using Flow.Launcher.Core.ExternalPlugins;
 using Flow.Launcher.Core.Resource;
 using Flow.Launcher.Infrastructure;
@@ -813,15 +814,13 @@ namespace Flow.Launcher.Core.Plugin
             return string.Empty;
         }
 
-        private static bool SameOrLesserPluginVersionExists(string metadataPath)
+        private static bool SameOrLesserPluginVersionExists(PluginMetadata metadata)
         {
-            var newMetadata = JsonSerializer.Deserialize<PluginMetadata>(File.ReadAllText(metadataPath));
-
-            if (!Version.TryParse(newMetadata.Version, out var newVersion))
+            if (!Version.TryParse(metadata.Version, out var newVersion))
                 return true; // If version is not valid, we assume it is lesser than any existing version
 
             // Get all plugins even if initialization failed so that we can check if the plugin with the same ID exists
-            return GetAllInitializedPlugins(includeFailed: true).Any(x => x.Metadata.ID == newMetadata.ID
+            return GetAllInitializedPlugins(includeFailed: true).Any(x => x.Metadata.ID == metadata.ID
                 && Version.TryParse(x.Metadata.Version, out var version)
                 && newVersion <= version);
         }
@@ -881,6 +880,8 @@ namespace Flow.Launcher.Core.Plugin
             var tempFolderPluginPath = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
             System.IO.Compression.ZipFile.ExtractToDirectory(zipFilePath, tempFolderPluginPath);
 
+            try
+            {
                 if (!plugin.IsFromLocalInstallPath)
                     File.Delete(zipFilePath);
 
@@ -897,13 +898,40 @@ namespace Flow.Launcher.Core.Plugin
                     return false;
                 }
 
-            if (SameOrLesserPluginVersionExists(metadataJsonFilePath))
+                PluginMetadata newMetadata;
+                try
+                {
+                    newMetadata = JsonSerializer.Deserialize<PluginMetadata>(File.ReadAllText(metadataJsonFilePath)) ??
+                        throw new JsonException("Deserialized metadata is null");
+                }
+                catch (Exception ex)
+                {
+                    PublicApi.Instance.ShowMsgError(Localize.failedToInstallPluginTitle(plugin.Name),
+                        Localize.pluginJsonInvalidOrCorrupted());
+                    PublicApi.Instance.LogException(ClassName,
+                        $"Failed to deserialize plugin metadata for plugin {plugin.Name} from file {metadataJsonFilePath}", ex);
+                    return false;
+                }
+
+                if (SameOrLesserPluginVersionExists(newMetadata))
                 {
                     PublicApi.Instance.ShowMsgError(Localize.failedToInstallPluginTitle(plugin.Name),
                         Localize.pluginExistAlreadyMessage());
                     return false;
                 }
 
+                if (!IsMinimumAppVersionSatisfied(newMetadata.Name, newMetadata.MinimumAppVersion))
+                {
+                    // Ask users if they want to install the plugin that doesn't satisfy the minimum app version requirement
+                    if (PublicApi.Instance.ShowMsgBox(
+                        Localize.pluginMinimumAppVersionUnsatisfiedMessage(newMetadata.Name, Environment.NewLine),
+                        Localize.pluginMinimumAppVersionUnsatisfiedTitle(newMetadata.Name, newMetadata.MinimumAppVersion),
+                        MessageBoxButton.YesNo) == MessageBoxResult.No)
+                    {
+                        return false;
+                    }
+                }
+
                 var folderName = string.IsNullOrEmpty(plugin.Version) ? $"{plugin.Name}-{Guid.NewGuid()}" : $"{plugin.Name}-{plugin.Version}";
 
                 var defaultPluginIDs = new List<string>
@@ -943,6 +971,15 @@ namespace Flow.Launcher.Core.Plugin
                     PublicApi.Instance.LogException(ClassName, $"Failed to delete plugin marker file in {newPluginPath}", e);
                 }
 
+                if (checkModified)
+                {
+                    ModifiedPlugins.Add(plugin.ID);
+                }
+
+                return true;
+            }
+            finally
+            {
                 try
                 {
                     if (Directory.Exists(tempFolderPluginPath))
@@ -952,13 +989,7 @@ namespace Flow.Launcher.Core.Plugin
                 {
                     PublicApi.Instance.LogException(ClassName, $"Failed to delete temp folder {tempFolderPluginPath}", e);
                 }
-
-            if (checkModified)
-            {
-                ModifiedPlugins.Add(plugin.ID);
             }
-
-            return true;
         }
 
         internal static async Task<bool> UninstallPluginAsync(PluginMetadata plugin, bool removePluginFromSettings, bool removePluginSettings, bool checkModified)
@@ -1050,6 +1081,27 @@ namespace Flow.Launcher.Core.Plugin
             return true;
         }
 
+        internal static bool IsMinimumAppVersionSatisfied(string pluginName, string minimumAppVersion)
+        {
+            // If the minimum app version is not specified in plugin.json, this plugin is compatible with all app versions
+            if (string.IsNullOrEmpty(minimumAppVersion))
+                return true;
+
+            var appVersion = Version.Parse(Constant.Version);
+
+            if (!Version.TryParse(minimumAppVersion, out var minimumVersion))
+            {
+                PublicApi.Instance.LogError(ClassName,
+                    $"Failed to parse the minimum app version {minimumAppVersion} for plugin {pluginName}.");
+                return false;  // If the minimum app version specified in plugin.json is invalid, we assume it is not satisfied
+            }
+
+            if (appVersion >= minimumVersion)
+                return true;
+
+            return false;
+        }
+
         #endregion
 
         #endregion

Flow.Launcher.Plugin/PluginMetadata.cs

@@ -137,6 +137,11 @@ namespace Flow.Launcher.Plugin
         [JsonIgnore]
         public int QueryCount { get; set; }
 
+        /// <summary>
+        /// The minimum Flow Launcher version required for this plugin. Default is "".
+        /// </summary>
+        public string MinimumAppVersion { get; set; } = string.Empty;
+
         /// <summary>
         /// The path to the plugin settings directory which is not validated.
         /// It is used to store plugin settings files and data files.

Flow.Launcher/Languages/en.xaml

@@ -232,6 +232,9 @@
     <system:String x:Key="fileNotFoundMessage">Unable to find plugin.json from the extracted zip file, or this path {0} does not exist</system:String>
     <system:String x:Key="pluginExistAlreadyMessage">A plugin with the same ID and version already exists, or the version is greater than this downloaded plugin</system:String>
     <system:String x:Key="errorCreatingSettingPanel">Error creating setting panel for plugin {0}:{1}{2}</system:String>
+    <system:String x:Key="pluginMinimumAppVersionUnsatisfiedTitle">{0} requires Flow version {1} to run</system:String>
+    <system:String x:Key="pluginMinimumAppVersionUnsatisfiedMessage">Flow does not meet the minimum version requirements for {0} to run. Do you want to continue installing it?{1}{1}We recommend updating Flow to the latest version to ensure that {0} works without issues.</system:String>
+    <system:String x:Key="pluginJsonInvalidOrCorrupted">Failed to install plugin because plugin.json is invalid or corrupted</system:String>
 
     <!--  Setting Plugin Store  -->
     <system:String x:Key="pluginStore">Plugin Store</system:String>