Merge pull request #3261 from Jack251970/multiple_keywords

Support Multiple keywords for Plugins

Author: Jack251970

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -231,7 +231,6 @@ public static ICollection<PluginPair> ValidPluginsForQuery(Query query)
             if (!NonGlobalPlugins.ContainsKey(query.ActionKeyword))
                 return GlobalPlugins;
 
-
             var plugin = NonGlobalPlugins[query.ActionKeyword];
             return new List<PluginPair>
             {
@@ -367,7 +366,16 @@ public static void AddActionKeyword(string id, string newActionKeyword)
                 NonGlobalPlugins[newActionKeyword] = plugin;
             }
 
+            // Update action keywords and action keyword in plugin metadata
             plugin.Metadata.ActionKeywords.Add(newActionKeyword);
+            if (plugin.Metadata.ActionKeywords.Count > 0)
+            {
+                plugin.Metadata.ActionKeyword = plugin.Metadata.ActionKeywords[0];
+            }
+            else
+            {
+                plugin.Metadata.ActionKeyword = string.Empty;
+            }
         }
 
         /// <summary>
@@ -388,16 +396,15 @@ public static void RemoveActionKeyword(string id, string oldActionkeyword)
             if (oldActionkeyword != Query.GlobalPluginWildcardSign)
                 NonGlobalPlugins.Remove(oldActionkeyword);
 
-
+            // Update action keywords and action keyword in plugin metadata
             plugin.Metadata.ActionKeywords.Remove(oldActionkeyword);
-        }
-
-        public static void ReplaceActionKeyword(string id, string oldActionKeyword, string newActionKeyword)
-        {
-            if (oldActionKeyword != newActionKeyword)
+            if (plugin.Metadata.ActionKeywords.Count > 0)
+            {
+                plugin.Metadata.ActionKeyword = plugin.Metadata.ActionKeywords[0];
+            }
+            else
             {
-                AddActionKeyword(id, newActionKeyword);
-                RemoveActionKeyword(id, oldActionKeyword);
+                plugin.Metadata.ActionKeyword = string.Empty;
             }
         }
 

Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs

@@ -152,7 +152,6 @@ public interface IPublicAPI
         /// <param name="callback"></param>
         public void RemoveGlobalKeyboardCallback(Func<int, int, SpecialKeyState, bool> callback);
 
-
         /// <summary>
         /// Fuzzy Search the string with the given query. This is the core search mechanism Flow uses
         /// </summary>
@@ -191,14 +190,15 @@ public interface IPublicAPI
         Task HttpDownloadAsync([NotNull] string url, [NotNull] string filePath, Action<double> reportProgress = null, CancellationToken token = default);
 
         /// <summary>
-        /// Add ActionKeyword for specific plugin
+        /// Add ActionKeyword and update action keyword metadata for specific plugin
+        /// Before adding, please check if action keyword is already assigned by <see cref="ActionKeywordAssigned"/>
         /// </summary>
         /// <param name="pluginId">ID for plugin that needs to add action keyword</param>
         /// <param name="newActionKeyword">The actionkeyword that is supposed to be added</param>
         void AddActionKeyword(string pluginId, string newActionKeyword);
 
         /// <summary>
-        /// Remove ActionKeyword for specific plugin
+        /// Remove ActionKeyword and update action keyword metadata for specific plugin
         /// </summary>
         /// <param name="pluginId">ID for plugin that needs to remove action keyword</param>
         /// <param name="oldActionKeyword">The actionkeyword that is supposed to be removed</param>

Flow.Launcher.Plugin/PluginMetadata.cs

@@ -34,6 +34,8 @@ internal set
 
         public List<string> ActionKeywords { get; set; }
 
+        public bool HideActionKeywordPanel { get; set; }
+
         public string IcoPath { get; set;}
 
         public override string ToString()

Flow.Launcher.Plugin/Query.cs

@@ -39,10 +39,9 @@ public Query() { }
         public const string TermSeparator = " ";
 
         /// <summary>
-        /// User can set multiple action keywords seperated by ';'
+        /// User can set multiple action keywords seperated by whitespace
         /// </summary>
-        public const string ActionKeywordSeparator = ";";
-
+        public const string ActionKeywordSeparator = TermSeparator;
 
         /// <summary>
         /// Wildcard action keyword. Plugins using this value will be queried on every search.

Flow.Launcher/ActionKeywords.xaml.cs

@@ -3,6 +3,8 @@
 using Flow.Launcher.Plugin;
 using Flow.Launcher.ViewModel;
 using Flow.Launcher.Core;
+using System.Linq;
+using System.Collections.Generic;
 
 namespace Flow.Launcher
 {
@@ -32,20 +34,59 @@ private void BtnCancel_OnClick(object sender, RoutedEventArgs e)
 
         private void btnDone_OnClick(object sender, RoutedEventArgs _)
         {
-            var oldActionKeyword = plugin.Metadata.ActionKeywords[0];
-            var newActionKeyword = tbAction.Text.Trim();
-            newActionKeyword = newActionKeyword.Length > 0 ? newActionKeyword : "*";
-            
-            if (!PluginViewModel.IsActionKeywordRegistered(newActionKeyword))
+            var oldActionKeywords = plugin.Metadata.ActionKeywords;
+
+            var newActionKeywords = tbAction.Text.Split(Query.ActionKeywordSeparator).ToList();
+            newActionKeywords.RemoveAll(string.IsNullOrEmpty);
+            newActionKeywords = newActionKeywords.Distinct().ToList();
+
+            newActionKeywords = newActionKeywords.Count > 0 ? newActionKeywords : new() { Query.GlobalPluginWildcardSign };
+
+            var addedActionKeywords = newActionKeywords.Except(oldActionKeywords).ToList();
+            var removedActionKeywords = oldActionKeywords.Except(newActionKeywords).ToList();
+            if (!addedActionKeywords.Any(App.API.ActionKeywordAssigned))
             {
-                pluginViewModel.ChangeActionKeyword(newActionKeyword, oldActionKeyword);
-                Close();
+                if (oldActionKeywords.Count != newActionKeywords.Count)
+                {
+                    ReplaceActionKeyword(plugin.Metadata.ID, removedActionKeywords, addedActionKeywords);
+                    return;
+                }
+
+                var sortedOldActionKeywords = oldActionKeywords.OrderBy(s => s).ToList();
+                var sortedNewActionKeywords = newActionKeywords.OrderBy(s => s).ToList();
+
+                if (sortedOldActionKeywords.SequenceEqual(sortedNewActionKeywords))
+                {
+                    // User just changes the sequence of action keywords
+                    var msg = translater.GetTranslation("newActionKeywordsSameAsOld");
+                    MessageBoxEx.Show(msg);
+                }
+                else
+                {
+                    ReplaceActionKeyword(plugin.Metadata.ID, removedActionKeywords, addedActionKeywords);
+                }
             }
             else
             {
                 string msg = translater.GetTranslation("newActionKeywordsHasBeenAssigned");
                 App.API.ShowMsgBox(msg);
             }
         }
+
+        private void ReplaceActionKeyword(string id, IReadOnlyList<string> removedActionKeywords, IReadOnlyList<string> addedActionKeywords)
+        {
+            foreach (var actionKeyword in removedActionKeywords)
+            {
+                App.API.RemoveActionKeyword(id, actionKeyword);
+            }
+            foreach (var actionKeyword in addedActionKeywords)
+            {
+                App.API.AddActionKeyword(id, actionKeyword);
+            }
+
+            // Update action keywords text and close window
+            pluginViewModel.OnActionKeywordsChanged();
+            Close();
+        }
     }
 }

Flow.Launcher/Languages/en.xaml

@@ -342,9 +342,10 @@
     <system:String x:Key="cannotFindSpecifiedPlugin">Can't find specified plugin</system:String>
     <system:String x:Key="newActionKeywordsCannotBeEmpty">New Action Keyword can't be empty</system:String>
     <system:String x:Key="newActionKeywordsHasBeenAssigned">This new Action Keyword is already assigned to another plugin, please choose a different one</system:String>
+    <system:String x:Key="newActionKeywordsSameAsOld">This new Action Keyword is the same as old, please choose a different one</system:String>
     <system:String x:Key="success">Success</system:String>
     <system:String x:Key="completedSuccessfully">Completed successfully</system:String>
-    <system:String x:Key="actionkeyword_tips">Enter the action keyword you like to use to start the plugin. Use * if you don't want to specify any, and the plugin will be triggered without any action keywords.</system:String>
+    <system:String x:Key="actionkeyword_tips">Enter the action keywords you like to use to start the plugin and use whitespace to divide them. Use * if you don't want to specify any, and the plugin will be triggered without any action keywords.</system:String>
 
     <!--  Custom Query Hotkey Dialog  -->
     <system:String x:Key="customeQueryHotkeyTitle">Custom Query Hotkey</system:String>

Flow.Launcher/PublicAPIInstance.cs

@@ -331,7 +331,6 @@ public bool IsGameModeOn()
             return _mainVM.GameModeStatus;
         }
 
-
         private readonly List<Func<int, int, SpecialKeyState, bool>> _globalKeyboardHandlers = new();
 
         public void RegisterGlobalKeyboardCallback(Func<int, int, SpecialKeyState, bool> callback) => _globalKeyboardHandlers.Add(callback);

Flow.Launcher/ViewModel/PluginViewModel.cs

@@ -43,7 +43,6 @@ private string PluginManagerActionKeyword
             }
         }
 
-
         private async void LoadIconAsync()
         {
             Image = await ImageLoader.LoadAsync(PluginPair.Metadata.IcoPath);
@@ -100,7 +99,7 @@ public Control SettingControl
                 : null;
         private ImageSource _image = ImageLoader.MissingImage;
 
-        public Visibility ActionKeywordsVisibility => PluginPair.Metadata.ActionKeywords.Count == 1 ? Visibility.Visible : Visibility.Collapsed;
+        public Visibility ActionKeywordsVisibility => PluginPair.Metadata.HideActionKeywordPanel ? Visibility.Collapsed : Visibility.Visible;
         public string InitilizaTime => PluginPair.Metadata.InitTime + "ms";
         public string QueryTime => PluginPair.Metadata.AvgQueryTime + "ms";
         public string Version => InternationalizationManager.Instance.GetTranslation("plugin_query_version") + " " + PluginPair.Metadata.Version;
@@ -109,9 +108,8 @@ public Control SettingControl
         public int Priority => PluginPair.Metadata.Priority;
         public Infrastructure.UserSettings.Plugin PluginSettingsObject { get; set; }
 
-        public void ChangeActionKeyword(string newActionKeyword, string oldActionKeyword)
+        public void OnActionKeywordsChanged()
         {
-            PluginManager.ReplaceActionKeyword(PluginPair.Metadata.ID, oldActionKeyword, newActionKeyword);
             OnPropertyChanged(nameof(ActionKeywordsText));
         }
 
@@ -150,8 +148,6 @@ private void OpenDeletePluginWindow()
             App.API.ShowMainWindow();
         }
 
-        public static bool IsActionKeywordRegistered(string newActionKeyword) => PluginManager.ActionKeywordRegistered(newActionKeyword);
-
         [RelayCommand]
         private void SetActionKeywords()
         {

Plugins/Flow.Launcher.Plugin.Calculator/Flow.Launcher.Plugin.Calculator.csproj

@@ -43,6 +43,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\Flow.Launcher.Core\Flow.Launcher.Core.csproj" />
+    <ProjectReference Include="..\..\Flow.Launcher.Plugin\Flow.Launcher.Plugin.csproj" />
   </ItemGroup>
 
   <ItemGroup>

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

@@ -7,6 +7,7 @@
     "*",
     "*"
   ],
+  "HideActionKeywordPanel": true,
   "Name": "Explorer",
   "Description": "Find and manage files and folders via Windows Search or Everything",
   "Author": "Jeremy Wu",