Merge pull request #621 from Flow-Launcher/add_quickaccess_actionkeyword

Add Quick Access action keyword for Explorer

Author: jjw24

Flow.Launcher.Infrastructure/UserSettings/PluginSettings.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Flow.Launcher.Plugin;
 
 namespace Flow.Launcher.Infrastructure.UserSettings
@@ -15,13 +15,24 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                 if (Plugins.ContainsKey(metadata.ID))
                 {
                     var settings = Plugins[metadata.ID];
-
-                    // TODO: Remove. This is backwards compatibility for 1.8.0 release.
-                    // Introduced two new action keywords in Explorer, so need to update plugin setting in the UserData folder.
+                    
                     if (metadata.ID == "572be03c74c642baae319fc283e561a8" && metadata.ActionKeywords.Count > settings.ActionKeywords.Count)
                     {
-                        settings.ActionKeywords.Add(Query.GlobalPluginWildcardSign); // for index search
-                        settings.ActionKeywords.Add(Query.GlobalPluginWildcardSign); // for path search
+                        // TODO: Remove. This is backwards compatibility for Explorer 1.8.0 release.
+                        // Introduced two new action keywords in Explorer, so need to update plugin setting in the UserData folder.
+                        if (settings.Version.CompareTo("1.8.0") < 0)
+                        {
+                            settings.ActionKeywords.Add(Query.GlobalPluginWildcardSign); // for index search
+                            settings.ActionKeywords.Add(Query.GlobalPluginWildcardSign); // for path search
+                            settings.ActionKeywords.Add(Query.GlobalPluginWildcardSign); // for quick access action keyword
+                        }
+
+                        // TODO: Remove. This is backwards compatibility for Explorer 1.9.0 release.
+                        // Introduced a new action keywords in Explorer since 1.8.0, so need to update plugin setting in the UserData folder.
+                        if (settings.Version.CompareTo("1.8.0") > 0)
+                        {
+                            settings.ActionKeywords.Add(Query.GlobalPluginWildcardSign); // for quick access action keyword
+                        }
                     }
 
                     if (string.IsNullOrEmpty(settings.Version))

Plugins/Flow.Launcher.Plugin.Explorer/Languages/en.xaml

@@ -10,6 +10,7 @@
     <system:String x:Key="plugin_explorer_deletefilefoldersuccess">Deletion successful</system:String>
     <system:String x:Key="plugin_explorer_deletefilefoldersuccess_detail">Successfully deleted the {0}</system:String>
     <system:String x:Key="plugin_explorer_globalActionKeywordInvalid">Assigning the global action keyword could bring up too many results during search. Please choose a specific action keyword</system:String>
+    <system:String x:Key="plugin_explorer_quickaccess_globalActionKeywordInvalid">Quick Access can not be set to the global action keyword when enabled. Please choose a specific action keyword</system:String>
     <system:String x:Key="plugin_explorer_windowsSearchServiceNotRunning">The required service for Windows Index Search does not appear to be running</system:String>
     <system:String x:Key="plugin_explorer_windowsSearchServiceFix">To fix this, start the Windows Search service. Select here to remove this warning</system:String>
     <system:String x:Key="plugin_explorer_alternative">The warning message has been switched off. As an alternative for searching files and folders, would you like to install Everything plugin?{0}{0}Select 'Yes' to install Everything plugin, or 'No' to return</system:String>
@@ -27,6 +28,7 @@
     <system:String x:Key="plugin_explorer_actionkeywordview_pathsearch">Path Search:</system:String>
     <system:String x:Key="plugin_explorer_actionkeywordview_filecontentsearch">File Content Search:</system:String>
     <system:String x:Key="plugin_explorer_actionkeywordview_indexsearch">Index Search:</system:String>
+    <system:String x:Key="plugin_explorer_actionkeywordview_quickaccess">Quick Access:</system:String>
     <system:String x:Key="plugin_explorer_actionkeyword_current">Current Action Keyword:</system:String>
     <system:String x:Key="plugin_explorer_actionkeyword_done">Done</system:String>
     <system:String x:Key="plugin_explorer_actionkeyword_enabled">Enabled</system:String>

Plugins/Flow.Launcher.Plugin.Explorer/Search/SearchManager.cs

@@ -42,27 +42,40 @@ internal async Task<List<Result>> SearchAsync(Query query, CancellationToken tok
         {
             var querySearch = query.Search;
 
+            var results = new HashSet<Result>(PathEqualityComparator.Instance);
+
+            // This allows the user to type the below action keywords and see/search the list of quick folder links
+            if (ActionKeywordMatch(query, Settings.ActionKeyword.SearchActionKeyword)
+                || ActionKeywordMatch(query, Settings.ActionKeyword.QuickAccessActionKeyword)
+                || ActionKeywordMatch(query, Settings.ActionKeyword.PathSearchActionKeyword))
+            {
+                if (string.IsNullOrEmpty(query.Search))
+                    return QuickAccess.AccessLinkListAll(query, Settings.QuickAccessLinks);
+
+                var quickaccessLinks = QuickAccess.AccessLinkListMatched(query, Settings.QuickAccessLinks);
+
+                results.UnionWith(quickaccessLinks);
+            }
+
             if (IsFileContentSearch(query.ActionKeyword))
                 return await WindowsIndexFileContentSearchAsync(query, querySearch, token).ConfigureAwait(false);
 
-            var result = new HashSet<Result>(PathEqualityComparator.Instance);
-
             if (ActionKeywordMatch(query, Settings.ActionKeyword.PathSearchActionKeyword) ||
                 ActionKeywordMatch(query, Settings.ActionKeyword.SearchActionKeyword))
             {
-                result.UnionWith(await PathSearchAsync(query, token).ConfigureAwait(false));
+                results.UnionWith(await PathSearchAsync(query, token).ConfigureAwait(false));
             }
 
             if ((ActionKeywordMatch(query, Settings.ActionKeyword.IndexSearchActionKeyword) ||
                  ActionKeywordMatch(query, Settings.ActionKeyword.SearchActionKeyword)) &&
                 querySearch.Length > 0 &&
                 !querySearch.IsLocationPathString())
             {
-                result.UnionWith(await WindowsIndexFilesAndFoldersSearchAsync(query, querySearch, token)
+                results.UnionWith(await WindowsIndexFilesAndFoldersSearchAsync(query, querySearch, token)
                     .ConfigureAwait(false));
             }
 
-            return result.ToList();
+            return results.ToList();
         }
 
         private bool ActionKeywordMatch(Query query, Settings.ActionKeyword allowedActionKeyword)
@@ -78,24 +91,18 @@ private bool ActionKeywordMatch(Query query, Settings.ActionKeyword allowedActio
                 Settings.ActionKeyword.FileContentSearchActionKeyword => Settings.FileContentSearchKeywordEnabled &&
                                                                          keyword == Settings.FileContentSearchActionKeyword,
                 Settings.ActionKeyword.IndexSearchActionKeyword => Settings.IndexSearchKeywordEnabled &&
-                                                                   keyword == Settings.IndexSearchActionKeyword
+                                                                   keyword == Settings.IndexSearchActionKeyword,
+                Settings.ActionKeyword.QuickAccessActionKeyword => Settings.QuickAccessKeywordEnabled &&
+                                                                        keyword == Settings.QuickAccessActionKeyword
             };
         }
 
         public async Task<List<Result>> PathSearchAsync(Query query, CancellationToken token = default)
         {
             var querySearch = query.Search;
 
-            // This allows the user to type the assigned action keyword and only see the list of quick folder links
-            if (string.IsNullOrEmpty(query.Search))
-                return QuickAccess.AccessLinkListAll(query, Settings.QuickAccessLinks);
-
             var results = new HashSet<Result>(PathEqualityComparator.Instance);
 
-            var quickaccessLinks = QuickAccess.AccessLinkListMatched(query, Settings.QuickAccessLinks);
-
-            results.UnionWith(quickaccessLinks);
-
             var isEnvironmentVariable = EnvironmentVariables.IsEnvironmentVariableSearch(querySearch);
 
             if (isEnvironmentVariable)

Plugins/Flow.Launcher.Plugin.Explorer/Settings.cs

@@ -19,6 +19,7 @@ public class Settings
         public List<AccessLink> IndexSearchExcludedSubdirectoryPaths { get; set; } = new List<AccessLink>();
 
         public string SearchActionKeyword { get; set; } = Query.GlobalPluginWildcardSign;
+
         public bool SearchActionKeywordEnabled { get; set; } = true;
 
         public string FileContentSearchActionKeyword { get; set; } = Constants.DefaultContentSearchActionKeyword;
@@ -33,14 +34,19 @@ public class Settings
 
         public bool IndexSearchKeywordEnabled { get; set; }
 
+        public string QuickAccessActionKeyword { get; set; } = Query.GlobalPluginWildcardSign;
+
+        public bool QuickAccessKeywordEnabled { get; set; }
+
         public bool WarnWindowsSearchServiceOff { get; set; } = true;
 
         internal enum ActionKeyword
         {
             SearchActionKeyword,
             PathSearchActionKeyword,
             FileContentSearchActionKeyword,
-            IndexSearchActionKeyword
+            IndexSearchActionKeyword,
+            QuickAccessActionKeyword
         }
 
         internal string GetActionKeyword(ActionKeyword actionKeyword) => actionKeyword switch
@@ -49,6 +55,7 @@ internal enum ActionKeyword
             ActionKeyword.PathSearchActionKeyword => PathSearchActionKeyword,
             ActionKeyword.FileContentSearchActionKeyword => FileContentSearchActionKeyword,
             ActionKeyword.IndexSearchActionKeyword => IndexSearchActionKeyword,
+            ActionKeyword.QuickAccessActionKeyword => QuickAccessActionKeyword,
             _ => throw new ArgumentOutOfRangeException(nameof(actionKeyword), actionKeyword, "ActionKeyWord property not found")
         };
 
@@ -58,6 +65,7 @@ internal enum ActionKeyword
             ActionKeyword.PathSearchActionKeyword => PathSearchActionKeyword = keyword,
             ActionKeyword.FileContentSearchActionKeyword => FileContentSearchActionKeyword = keyword,
             ActionKeyword.IndexSearchActionKeyword => IndexSearchActionKeyword = keyword,
+            ActionKeyword.QuickAccessActionKeyword => QuickAccessActionKeyword = keyword,
             _ => throw new ArgumentOutOfRangeException(nameof(actionKeyword), actionKeyword, "ActionKeyWord property not found")
         };
 
@@ -67,6 +75,7 @@ internal enum ActionKeyword
             ActionKeyword.PathSearchActionKeyword => PathSearchKeywordEnabled,
             ActionKeyword.IndexSearchActionKeyword => IndexSearchKeywordEnabled,
             ActionKeyword.FileContentSearchActionKeyword => FileContentSearchKeywordEnabled,
+            ActionKeyword.QuickAccessActionKeyword => QuickAccessKeywordEnabled,
             _ => throw new ArgumentOutOfRangeException(nameof(actionKeyword), actionKeyword, "ActionKeyword enabled status not defined")
         };
 
@@ -76,6 +85,7 @@ internal enum ActionKeyword
             ActionKeyword.PathSearchActionKeyword => PathSearchKeywordEnabled = enable,
             ActionKeyword.IndexSearchActionKeyword => IndexSearchKeywordEnabled = enable,
             ActionKeyword.FileContentSearchActionKeyword => FileContentSearchKeywordEnabled = enable,
+            ActionKeyword.QuickAccessActionKeyword => QuickAccessKeywordEnabled = enable,
             _ => throw new ArgumentOutOfRangeException(nameof(actionKeyword), actionKeyword, "ActionKeyword enabled status not defined")
         };
     }

Plugins/Flow.Launcher.Plugin.Explorer/Views/ActionKeywordSetting.xaml.cs

@@ -59,14 +59,16 @@ private void OnDoneButtonClick(object sender, RoutedEventArgs e)
             }
 
 
-            if (CurrentActionKeyword.KeywordProperty == Settings.ActionKeyword.FileContentSearchActionKeyword 
-                && ActionKeyword == Query.GlobalPluginWildcardSign)
-            {
-                MessageBox.Show(
-                    settingsViewModel.Context.API.GetTranslation("plugin_explorer_globalActionKeywordInvalid"));
-
-                return;
-            }
+            if (ActionKeyword == Query.GlobalPluginWildcardSign)
+                switch (CurrentActionKeyword.KeywordProperty)
+                {
+                    case Settings.ActionKeyword.FileContentSearchActionKeyword:
+                        MessageBox.Show(settingsViewModel.Context.API.GetTranslation("plugin_explorer_globalActionKeywordInvalid"));
+                        return;
+                    case Settings.ActionKeyword.QuickAccessActionKeyword:
+                        MessageBox.Show(settingsViewModel.Context.API.GetTranslation("plugin_explorer_quickaccess_globalActionKeywordInvalid"));
+                        return;
+                }
 
             var oldActionKeyword = CurrentActionKeyword.Keyword;
 

Plugins/Flow.Launcher.Plugin.Explorer/Views/ExplorerSettings.xaml.cs

@@ -42,7 +42,9 @@ public ExplorerSettings(SettingsViewModel viewModel)
                 new(Settings.ActionKeyword.PathSearchActionKeyword,
                     viewModel.Context.API.GetTranslation("plugin_explorer_actionkeywordview_pathsearch")),
                 new(Settings.ActionKeyword.IndexSearchActionKeyword,
-                    viewModel.Context.API.GetTranslation("plugin_explorer_actionkeywordview_indexsearch"))
+                    viewModel.Context.API.GetTranslation("plugin_explorer_actionkeywordview_indexsearch")),
+                new(Settings.ActionKeyword.QuickAccessActionKeyword,
+                    viewModel.Context.API.GetTranslation("plugin_explorer_actionkeywordview_quickaccess"))
             };
 
             lbxActionKeywords.ItemsSource = actionKeywordsListView;

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

@@ -4,12 +4,13 @@
     "*",
     "doc:",
     "*",
+    "*",
     "*"
   ],
   "Name": "Explorer",
   "Description": "Search and manage files and folders. Explorer utilises Windows Index Search",
   "Author": "Jeremy Wu",
-  "Version": "1.8.5",
+  "Version": "1.9.0",
   "Language": "csharp",
   "Website": "https://github.com/Flow-Launcher/Flow.Launcher",
   "ExecuteFileName": "Flow.Launcher.Plugin.Explorer.dll",