Merge branch 'dev' into move-exception-message-to-result

Author: Garulf

.github/actions/spelling/expect.txt

@@ -1,7 +1,6 @@
 crowdin
 DWM
 workflows
-Wpf
 wpf
 actionkeyword
 stackoverflow
@@ -20,9 +19,7 @@ Prioritise
 Segoe
 Google
 Customise
-UWP
 uwp
-Uwp
 Bokmal
 Bokm
 uninstallation
@@ -61,7 +58,6 @@ popup
 ptr
 pluginindicator
 TobiasSekan
-Img
 img
 resx
 bak
@@ -78,7 +74,6 @@ WCA_ACCENT_POLICY
 HGlobal
 dopusrt
 firefox
-Firefox
 msedge
 svgc
 ime
@@ -87,7 +82,6 @@ txb
 btn
 otf
 searchplugin
-Noresult
 wpftk
 mkv
 flac
@@ -108,4 +102,6 @@ Preinstalled
 errormetadatafile
 noresult
 pluginsmanager
-alreadyexists
+alreadyexists
+JsonRPC
+JsonRPCV2

.github/actions/spelling/patterns.txt

@@ -118,3 +118,6 @@
 
 # UWP
 [Uu][Ww][Pp]
+
+# version suffix <word>v#
+(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))

.github/workflows/spelling.yml

@@ -73,7 +73,7 @@ jobs:
     steps:
     - name: check-spelling
       id: spelling
-      uses: check-spelling/check-spelling@v0.0.22
+      uses: check-spelling/check-spelling@prerelease
       with:
         suppress_push_for_open_pull_request: 1
         checkout: true
@@ -91,10 +91,9 @@ jobs:
         extra_dictionaries:
           cspell:software-terms/dict/softwareTerms.txt
           cspell:win32/src/win32.txt
-          cspell:php/src/php.txt
           cspell:filetypes/filetypes.txt
           cspell:csharp/csharp.txt
-          cspell:dotnet/src/dotnet.txt
+          cspell:dotnet/dict/dotnet.txt
           cspell:python/src/common/extra.txt
           cspell:python/src/python/python-lib.txt
           cspell:aws/aws.txt
@@ -130,7 +129,7 @@ jobs:
     if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')
     steps:
     - name: comment
-      uses: check-spelling/check-spelling@v0.0.22
+      uses: check-spelling/check-spelling@prerelease
       with:
         checkout: true
         spell_check_this: check-spelling/spell-check-this@main

Flow.Launcher.Core/Flow.Launcher.Core.csproj

@@ -54,7 +54,7 @@
 
   <ItemGroup>
     <PackageReference Include="Droplex" Version="1.7.0" />
-    <PackageReference Include="FSharp.Core" Version="7.0.400" />
+    <PackageReference Include="FSharp.Core" Version="7.0.401" />
     <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="2.3.2" />
     <PackageReference Include="squirrel.windows" Version="1.5.2" NoWarn="NU1701" />
     <PackageReference Include="StreamJsonRpc" Version="2.16.36" />

Flow.Launcher.Core/Plugin/JsonPRCModel.cs

@@ -25,7 +25,7 @@ public record JsonRPCErrorModel(int Code, string Message, string Data);
     public record JsonRPCResponseModel(int Id, JsonRPCErrorModel Error = default) : JsonRPCBase(Id, Error);
     public record JsonRPCQueryResponseModel(int Id,
         [property: JsonPropertyName("result")] List<JsonRPCResult> Result,
-        IReadOnlyDictionary<string, object> SettingsChanges = null,
+        IReadOnlyDictionary<string, object> SettingsChange = null,
         string DebugMessage = "",
         JsonRPCErrorModel Error = default) : JsonRPCResponseModel(Id, Error);
 

Flow.Launcher.Core/Plugin/JsonRPCPluginBase.cs

@@ -94,7 +94,7 @@ protected List<Result> ParseResults(JsonRPCQueryResponseModel queryResponseModel
 
             results.AddRange(queryResponseModel.Result);
 
-            Settings?.UpdateSettings(queryResponseModel.SettingsChanges);
+            Settings?.UpdateSettings(queryResponseModel.SettingsChange);
 
             return results;
         }
@@ -126,14 +126,15 @@ protected void ExecuteFlowLauncherAPI(string method, object[] parameters)
 
         private async Task InitSettingAsync()
         {
-            if (!File.Exists(SettingConfigurationPath))
-                return;
+            JsonRpcConfigurationModel configuration = null;
+            if (File.Exists(SettingConfigurationPath))
+            {
+                var deserializer = new DeserializerBuilder().WithNamingConvention(CamelCaseNamingConvention.Instance).Build();
+                configuration =
+                    deserializer.Deserialize<JsonRpcConfigurationModel>(
+                        await File.ReadAllTextAsync(SettingConfigurationPath));
+            }
 
-            var deserializer = new DeserializerBuilder().WithNamingConvention(CamelCaseNamingConvention.Instance)
-                .Build();
-            var configuration =
-                deserializer.Deserialize<JsonRpcConfigurationModel>(
-                    await File.ReadAllTextAsync(SettingConfigurationPath));
 
             Settings ??= new JsonRPCPluginSettings
             {

Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Controls;
@@ -10,16 +11,16 @@ namespace Flow.Launcher.Core.Plugin
 {
     public class JsonRPCPluginSettings
     {
-        public required JsonRpcConfigurationModel Configuration { get; init; }
+        public required JsonRpcConfigurationModel? Configuration { get; init; }
 
         public required string SettingPath { get; init; }
         public Dictionary<string, FrameworkElement> SettingControls { get; } = new();
 
         public IReadOnlyDictionary<string, object> Inner => Settings;
-        protected Dictionary<string, object> Settings { get; set; }
+        protected ConcurrentDictionary<string, object> Settings { get; set; }
         public required IPublicAPI API { get; init; }
 
-        private JsonStorage<Dictionary<string, object>> _storage;
+        private JsonStorage<ConcurrentDictionary<string, object>> _storage;
 
         // maybe move to resource?
         private static readonly Thickness settingControlMargin = new(0, 9, 18, 9);
@@ -33,9 +34,14 @@ public class JsonRPCPluginSettings
 
         public async Task InitializeAsync()
         {
-            _storage = new JsonStorage<Dictionary<string, object>>(SettingPath);
+            _storage = new JsonStorage<ConcurrentDictionary<string, object>>(SettingPath);
             Settings = await _storage.LoadAsync();
 
+            if (Settings != null)
+            {
+                return;
+            }
+
             foreach (var (type, attributes) in Configuration.Body) 
             {
                 if (attributes.Name == null)
@@ -58,10 +64,7 @@ public void UpdateSettings(IReadOnlyDictionary<string, object> settings)
 
             foreach (var (key, value) in settings)
             {
-                if (Settings.ContainsKey(key))
-                {
-                    Settings[key] = value;
-                }
+                Settings[key] = value;
 
                 if (SettingControls.TryGetValue(key, out var control))
                 {
@@ -82,6 +85,7 @@ public void UpdateSettings(IReadOnlyDictionary<string, object> settings)
                     }
                 }
             }
+            Save();
         }
 
         public async Task SaveAsync()

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -11,6 +11,8 @@
 using Flow.Launcher.Infrastructure.UserSettings;
 using Flow.Launcher.Plugin;
 using ISavable = Flow.Launcher.Plugin.ISavable;
+using Flow.Launcher.Plugin.SharedCommands;
+using System.Text.Json;
 
 namespace Flow.Launcher.Core.Plugin
 {
@@ -27,9 +29,9 @@ public static class PluginManager
 
         public static IPublicAPI API { private set; get; }
 
-        // todo happlebao, this should not be public, the indicator function should be embeded 
-        public static PluginsSettings Settings;
+        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
@@ -343,5 +345,156 @@ public static void ReplaceActionKeyword(string id, string oldActionKeyword, stri
                 RemoveActionKeyword(id, oldActionKeyword);
             }
         }
+
+        private static string GetContainingFolderPathAfterUnzip(string unzippedParentFolderPath)
+        {
+            var unzippedFolderCount = Directory.GetDirectories(unzippedParentFolderPath).Length;
+            var unzippedFilesCount = Directory.GetFiles(unzippedParentFolderPath).Length;
+
+            // adjust path depending on how the plugin is zipped up
+            // the recommended should be to zip up the folder not the contents
+            if (unzippedFolderCount == 1 && unzippedFilesCount == 0)
+                // folder is zipped up, unzipped plugin directory structure: tempPath/unzippedParentPluginFolder/pluginFolderName/
+                return Directory.GetDirectories(unzippedParentFolderPath)[0];
+
+            if (unzippedFilesCount > 1)
+                // content is zipped up, unzipped plugin directory structure: tempPath/unzippedParentPluginFolder/
+                return unzippedParentFolderPath;
+
+            return string.Empty;
+        }
+
+        private static bool SameOrLesserPluginVersionExists(string metadataPath)
+        {
+            var newMetadata = JsonSerializer.Deserialize<PluginMetadata>(File.ReadAllText(metadataPath));
+            return AllPlugins.Any(x => x.Metadata.ID == newMetadata.ID
+                          && newMetadata.Version.CompareTo(x.Metadata.Version) <= 0);
+        }
+
+        #region Public functions
+
+        public static bool PluginModified(string uuid)
+        {
+            return _modifiedPlugins.Contains(uuid);
+        }
+
+
+        /// <summary>
+        /// Update a plugin to new version, from a zip file. Will Delete zip after updating.
+        /// </summary>
+        public static void UpdatePlugin(PluginMetadata existingVersion, UserPlugin newVersion, string zipFilePath)
+        {
+            InstallPlugin(newVersion, zipFilePath, checkModified:false);
+            UninstallPlugin(existingVersion, removeSettings:false, checkModified:false);
+            _modifiedPlugins.Add(existingVersion.ID);
+        }
+
+        /// <summary>
+        /// Install a plugin. Will Delete zip after updating.
+        /// </summary>
+        public static void InstallPlugin(UserPlugin plugin, string zipFilePath)
+        {
+            InstallPlugin(plugin, zipFilePath, true);
+        }
+
+        /// <summary>
+        /// Uninstall a plugin.
+        /// </summary>
+        public static void UninstallPlugin(PluginMetadata plugin, bool removeSettings = true)
+        {
+            UninstallPlugin(plugin, removeSettings, true);
+        }
+
+        #endregion
+
+        #region Internal functions
+
+        internal static void InstallPlugin(UserPlugin plugin, string zipFilePath, 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));
+            }
+
+            // Unzip plugin files to temp folder
+            var tempFolderPluginPath = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
+            System.IO.Compression.ZipFile.ExtractToDirectory(zipFilePath, tempFolderPluginPath);
+            File.Delete(zipFilePath);
+
+            var pluginFolderPath = GetContainingFolderPathAfterUnzip(tempFolderPluginPath);
+
+            var metadataJsonFilePath = string.Empty;
+            if (File.Exists(Path.Combine(pluginFolderPath, Constant.PluginMetadataFileName)))
+                metadataJsonFilePath = Path.Combine(pluginFolderPath, Constant.PluginMetadataFileName);
+
+            if (string.IsNullOrEmpty(metadataJsonFilePath) || string.IsNullOrEmpty(pluginFolderPath))
+            {
+                throw new FileNotFoundException($"Unable to find plugin.json from the extracted zip file, or this path {pluginFolderPath} does not exist");
+            }
+
+            if (SameOrLesserPluginVersionExists(metadataJsonFilePath))
+            {
+                throw new InvalidOperationException($"A plugin with the same ID and version already exists, or the version is greater than this downloaded plugin {plugin.Name}");
+            }
+
+            var folderName = string.IsNullOrEmpty(plugin.Version) ? $"{plugin.Name}-{Guid.NewGuid()}" : $"{plugin.Name}-{plugin.Version}";
+
+            var defaultPluginIDs = new List<string>
+                                    {
+                                        "0ECADE17459B49F587BF81DC3A125110", // BrowserBookmark
+                                        "CEA0FDFC6D3B4085823D60DC76F28855", // Calculator
+                                        "572be03c74c642baae319fc283e561a8", // Explorer
+                                        "6A122269676E40EB86EB543B945932B9", // PluginIndicator
+                                        "9f8f9b14-2518-4907-b211-35ab6290dee7", // PluginsManager
+                                        "b64d0a79-329a-48b0-b53f-d658318a1bf6", // ProcessKiller
+                                        "791FC278BA414111B8D1886DFE447410", // Program
+                                        "D409510CD0D2481F853690A07E6DC426", // Shell
+                                        "CEA08895D2544B019B2E9C5009600DF4", // Sys
+                                        "0308FD86DE0A4DEE8D62B9B535370992", // URL
+                                        "565B73353DBF4806919830B9202EE3BF", // WebSearch
+                                        "5043CETYU6A748679OPA02D27D99677A" // WindowsSettings
+                                    };
+
+            // Treat default plugin differently, it needs to be removable along with each flow release
+            var installDirectory = !defaultPluginIDs.Any(x => x == plugin.ID)
+                                    ? DataLocation.PluginsDirectory
+                                    : Constant.PreinstalledDirectory;
+
+            var newPluginPath = Path.Combine(installDirectory, folderName);
+
+            FilesFolders.CopyAll(pluginFolderPath, newPluginPath);
+
+            Directory.Delete(tempFolderPluginPath, true);
+
+            if (checkModified)
+            {
+                _modifiedPlugins.Add(plugin.ID);
+            }
+        }
+
+        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);
+                AllPlugins.RemoveAll(p => p.Metadata.ID == plugin.ID);
+            }
+
+            // 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
     }
 }

Flow.Launcher.Core/Plugin/ProcessStreamPluginV2.cs

@@ -17,7 +17,7 @@ internal abstract class ProcessStreamPluginV2 : JsonRPCPluginV2
 
         protected abstract ProcessStartInfo StartInfo { get; set; }
 
-        public Process ClientProcess { get; set; }
+        protected Process ClientProcess { get; set; }
 
         public override async Task InitAsync(PluginInitContext context)
         {
@@ -33,6 +33,8 @@ public override async Task InitAsync(PluginInitContext context)
 
             SetupPipe(ClientProcess);
 
+            ErrorStream = ClientProcess.StandardError;
+
             await base.InitAsync(context);
         }