IPluginHotkey Interface for Global Hotkey & Window Hotkey / Support Rename File & Folder by Hotkey or Context Menu

Flow.Launcher.Infrastructure/UserSettings/Settings.cs

@@ -26,7 +26,7 @@
         public void Initialize()
         {
             // Initialize dependency injection instances after Ioc.Default is created
             _stringMatcher = Ioc.Default.GetRequiredService<StringMatcher>();
 
             // Initialize application resources after application is created
             var settingWindowFont = new FontFamily(SettingWindowFont);
@@ -58,6 +58,7 @@
         public string OpenHistoryHotkey { get; set; } = $"Ctrl+H";
         public string CycleHistoryUpHotkey { get; set; } = $"{KeyConstant.Alt} + Up";
         public string CycleHistoryDownHotkey { get; set; } = $"{KeyConstant.Alt} + Down";
+        public string RenameFileHotkey { get; set; } = $"F2";
 
         private string _language = Constant.SystemLanguageCode;
         public string Language
@@ -472,13 +473,14 @@
                     list.Add(new(CycleHistoryUpHotkey, "CycleHistoryUpHotkey", () => CycleHistoryUpHotkey = ""));
                 if (!string.IsNullOrEmpty(CycleHistoryDownHotkey))
                     list.Add(new(CycleHistoryDownHotkey, "CycleHistoryDownHotkey", () => CycleHistoryDownHotkey = ""));
-
+                if (!string.IsNullOrEmpty(RenameFileHotkey))
+                    list.Add(new RegisteredHotkeyData(RenameFileHotkey, "RenameFileHotkey", () => RenameFileHotkey = ""));
                 // Custom Query Hotkeys
-                foreach (var customPluginHotkey in CustomPluginHotkeys)
-                {
-                    if (!string.IsNullOrEmpty(customPluginHotkey.Hotkey))
-                        list.Add(new(customPluginHotkey.Hotkey, "customQueryHotkey", () => customPluginHotkey.Hotkey = ""));
-                }
+                    foreach (var customPluginHotkey in CustomPluginHotkeys)
+                    {
+                        if (!string.IsNullOrEmpty(customPluginHotkey.Hotkey))
+                            list.Add(new(customPluginHotkey.Hotkey, "customQueryHotkey", () => customPluginHotkey.Hotkey = ""));
+                    }
 
                 return list;
             }

Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs

@@ -226,8 +226,25 @@
         /// <param name="query">Query string</param>
         /// <param name="stringToCompare">The string that will be compared against the query</param>
         /// <returns>Match results</returns>
+
         MatchResult FuzzySearch(string query, string stringToCompare);
 
+        /// <summary>
+        /// Returns if the given name is valid file name even if it doesn't exist
+        /// </summary>
+        /// <param name="name">the name to check</param>
+        public bool IsValidFileName(string name);
+        /// <summary>
+        /// Returns if the given name is valid directory name even if it doesn't exist
+        /// </summary>
+        /// <param name="name">the name to check</param>
+        public bool IsValidDirectoryName(string name);
+        /// <summary>
+        /// Open A dialog to rename the given file or folder
+        /// </summary>
+        /// <param name="info">The directory or file info for the thing to rename. You must check if it actually exists or this will throw an exception</param>
+
+
         /// <summary>
         /// Http download the spefic url and return as string
         /// </summary>
@@ -237,7 +254,7 @@
         Task<string> HttpGetStringAsync(string url, CancellationToken token = default);
 
         /// <summary>
         /// Http download the spefic url and return as stream
         /// </summary>
         /// <param name="url">URL to call Http Get</param>
         /// <param name="token">Cancellation Token</param>
@@ -393,7 +410,7 @@
 
         /// <summary>
         /// Reloads the query.
         /// When current results are from context menu or history, it will go back to query results before requerying.
         /// </summary>
         /// <param name="reselect">Choose the first result after reload if true; keep the last selected result if false. Default is true.</param>
         public void ReQuery(bool reselect = true);

Flow.Launcher/HotkeyControl.xaml.cs

@@ -1,4 +1,5 @@
 using System.Collections.ObjectModel;
+using System.IO;
 using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Input;
@@ -110,12 +111,14 @@
             SelectPrevItemHotkey,
             SelectPrevItemHotkey2,
             SelectNextItemHotkey,
-            SelectNextItemHotkey2
+            SelectNextItemHotkey2,
+            RenameFileHotkey
+
         }
 
         // We can initialize settings in static field because it has been constructed in App constuctor
         // and it will not construct settings instances twice
         private static readonly Settings _settings = Ioc.Default.GetRequiredService<Settings>();
 
         private string hotkey = string.Empty;
         public string Hotkey
@@ -142,6 +145,8 @@
                     HotkeyType.SelectPrevItemHotkey2 => _settings.SelectPrevItemHotkey2,
                     HotkeyType.SelectNextItemHotkey => _settings.SelectNextItemHotkey,
                     HotkeyType.SelectNextItemHotkey2 => _settings.SelectNextItemHotkey2,
+                    HotkeyType.RenameFileHotkey => _settings.RenameFileHotkey,
+
                     _ => throw new System.NotImplementedException("Hotkey type not set")
                 };
             }
@@ -201,6 +206,9 @@
                     case HotkeyType.SelectNextItemHotkey2:
                         _settings.SelectNextItemHotkey2 = value;
                         break;
+                    case HotkeyType.RenameFileHotkey:
+                        _settings.RenameFileHotkey = value;
+                        break;
                     default:
                         throw new System.NotImplementedException("Hotkey type not set");
                 }
@@ -231,7 +239,7 @@
 
         public string EmptyHotkey => App.API.GetTranslation("none");
 
-        public ObservableCollection<string> KeysToDisplay { get; set; } = new();
+        public ObservableCollection<string> KeysToDisplay { get; set; } = new ObservableCollection<string>();
 
         public HotkeyModel CurrentHotkey { get; private set; } = new(false, false, false, false, Key.None);
 
@@ -258,10 +266,10 @@
                 case HotkeyControlDialog.EResultType.Cancel:
                     SetHotkey(Hotkey);
                     return;
                 case HotkeyControlDialog.EResultType.Save:
                     SetHotkey(dialog.ResultValue);
                     break;
                 case HotkeyControlDialog.EResultType.Delete:
                     Delete();
                     break;
             }
@@ -308,6 +316,7 @@
 
         private void SetKeysToDisplay(HotkeyModel? hotkey)
         {
+
             KeysToDisplay.Clear();
 
             if (hotkey == null || hotkey == default(HotkeyModel))
@@ -318,8 +327,11 @@
 
             foreach (var key in hotkey.Value.EnumerateDisplayKeys()!)
             {
+
                 KeysToDisplay.Add(key);
             }
+
+
         }
 
         public void SetHotkey(string? keyStr, bool triggerValidate = true)

Flow.Launcher/Languages/en.xaml

@@ -555,4 +555,9 @@
     <system:String x:Key="FileSize">File Size</system:String>
     <system:String x:Key="Created">Created</system:String>
     <system:String x:Key="LastModified">Last Modified</system:String>
+
+
+    <system:String x:Key="RenameFileHotkey">Rename a file/directory</system:String>
+    <system:String x:Key="AreTryingToRenameFile">Are you trying to rename a file?</system:String>
+    <system:String x:Key="ExplorerNeedsEnabledForRenameFile">"The explorer plugin needs to be enabled for the hotkey to rename files to work."</system:String>
 </ResourceDictionary>

Flow.Launcher/MainWindow.xaml

@@ -211,6 +211,10 @@
             Key="{Binding CycleHistoryDownHotkey, Converter={StaticResource StringToKeyBindingConverter}, ConverterParameter='key'}"
             Command="{Binding ForwardHistoryCommand}"
             Modifiers="{Binding CycleHistoryDownHotkey, Converter={StaticResource StringToKeyBindingConverter}, ConverterParameter='modifiers'}" />
+        <KeyBinding
+            Key="{Binding RenameFileHotkey, Converter={StaticResource StringToKeyBindingConverter}, ConverterParameter='key'}"
+            Command="{Binding RenameFileCommand}"
+            Modifiers="{Binding RenameFileHotkey, Converter={StaticResource StringToKeyBindingConverter}, ConverterParameter='modifiers'}" />
     </Window.InputBindings>
 
     <Border MouseDown="OnMouseDown" Style="{DynamicResource WindowBorderStyle}">

Flow.Launcher/PublicAPIInstance.cs

@@ -33,6 +33,7 @@
 using JetBrains.Annotations;
 using Squirrel;
 using Stopwatch = Flow.Launcher.Infrastructure.Stopwatch;
+using Windows.Foundation.Metadata;
 
 namespace Flow.Launcher
 {
@@ -45,11 +46,11 @@
 
         // Must use getter to avoid accessing Application.Current.Resources.MergedDictionaries so earlier in theme constructor
         private Theme _theme;
         private Theme Theme => _theme ??= Ioc.Default.GetRequiredService<Theme>();
 
         // Must use getter to avoid circular dependency
         private Updater _updater;
         private Updater Updater => _updater ??= Ioc.Default.GetRequiredService<Updater>();
 
         private readonly object _saveSettingsLock = new();
 
@@ -158,7 +159,7 @@
             ShellCommand.Execute(startInfo);
         }
 
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD100:Avoid async void methods", Justification = "<Pending>")]
         public async void CopyToClipboard(string stringToCopy, bool directCopy = false, bool showDefaultNotification = true)
         {
             if (string.IsNullOrEmpty(stringToCopy))
@@ -222,7 +223,26 @@
                 }  
             }
         }
-
+        public bool IsValidFileName(string name)
+        {
+            if (name.IndexOfAny(Path.GetInvalidFileNameChars()) >= 0 || name.Trim() == "")
+            {
+                return false;
+            }
+            return true;
+        }
+        public bool IsValidDirectoryName(string name)
+        {
+            List<char> invalidChars = Path.GetInvalidPathChars().ToList();
+            invalidChars.Add('/');
+            invalidChars.Add('\\');
+            if (name.IndexOfAny(invalidChars.ToArray()) >= 0 || name.Trim() == "")
+            {
+                return false;
+            }
+            return true;
+        }
+
         private static async Task<Exception> RetryActionOnSTAThreadAsync(Action action, int retryCount = 6, int retryDelay = 150)
         {
             for (var i = 0; i < retryCount; i++)

Flow.Launcher/SettingPages/Views/SettingsPaneHotkey.xaml

@@ -204,6 +204,15 @@
                             <cc:HotkeyDisplay Margin="4 0 0 0" Keys="Ctrl+Minus" />
                         </StackPanel>
                     </cc:Card>
+                     <cc:Card
+                            Title="{DynamicResource RenameFileHotkey}"
+                            Icon="&#xe70f;"
+                            Type="Inside">
+                            <flowlauncher:HotkeyControl
+                                DefaultHotkey=""
+                                Type="RenameFileHotkey"
+                                ValidateKeyGesture="True"/>
+                        </cc:Card>
                 </StackPanel>
             </cc:ExCard>
 

Flow.Launcher/ViewModel/MainViewModel.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.Globalization;
+using System.IO;
 using System.Linq;
 using System.Text;
 using System.Threading;
@@ -22,6 +23,7 @@
 using Flow.Launcher.Plugin.SharedCommands;
 using Flow.Launcher.Storage;
 using Microsoft.VisualStudio.Threading;
+using Svg;
 
 namespace Flow.Launcher.ViewModel
 {
@@ -60,6 +62,8 @@ public partial class MainViewModel : BaseModel, ISavable, IDisposable
 
         #endregion
 
+
+
         #region Constructor
 
         public MainViewModel()
@@ -140,6 +144,9 @@ public MainViewModel()
                     case nameof(Settings.OpenHistoryHotkey):
                         OnPropertyChanged(nameof(OpenHistoryHotkey));
                         break;
+                    case nameof(Settings.RenameFileHotkey):
+                        OnPropertyChanged(nameof(Settings.RenameFileHotkey));
+                        break;
                 }
             };
 
@@ -596,6 +603,7 @@ public void CopyAlternative()
         #endregion
 
         #region ViewModel Properties
+
 
         public Settings Settings { get; }
         public string ClockText { get; private set; }
@@ -913,9 +921,60 @@ private static string VerifyOrSetDefaultHotkey(string hotkey, string defaultHotk
         public string OpenHistoryHotkey => VerifyOrSetDefaultHotkey(Settings.OpenHistoryHotkey, "Ctrl+H");
         public string CycleHistoryUpHotkey => VerifyOrSetDefaultHotkey(Settings.CycleHistoryUpHotkey, "Alt+Up");
         public string CycleHistoryDownHotkey => VerifyOrSetDefaultHotkey(Settings.CycleHistoryDownHotkey, "Alt+Down");
+        public string RenameFileHotkey => VerifyOrSetDefaultHotkey(Settings.RenameFileHotkey, "F2");
+
 
         public bool StartWithEnglishMode => Settings.AlwaysStartEn;
 
+        #region renamingFiles
+        private int timesTriedToRenameFileWithExplorerDisabled = 0;
+
+        [RelayCommand]
+        private void RenameFile()
+        {
+
+            const string explorerPluginID = "572be03c74c642baae319fc283e561a8";
+            // check if explorer plugin is enabled
+            IEnumerable<PluginPair> explorerPluginMatches = App.API.GetAllPlugins().Where(
+                plugin => plugin.Metadata.ID == explorerPluginID);
+
+            if (!explorerPluginMatches.Any() || explorerPluginMatches == null)
+            {
+
+                timesTriedToRenameFileWithExplorerDisabled++;
+                return;
+            }
+            else if ((!explorerPluginMatches.Any() || explorerPluginMatches == null) && timesTriedToRenameFileWithExplorerDisabled > 3)
+            {
+                App.API.ShowMsg(App.API.GetTranslation("AreTryingToRenameFile"), App.API.GetTranslation("ExplorerNeedsEnabledForRenameFile"));
+                timesTriedToRenameFileWithExplorerDisabled = 0;
+                return;
+            }
+            else
+            {
+                // at runtime the type of the will be <see cref="../../Plugins/Flow.Launcher.Plugin.Explorer/Main.cs" />
+                dynamic explorerPlugin = explorerPluginMatches.First(); // assuming there's only one match
+                string path = SelectedResults?.SelectedItem?.Result.SubTitle ?? "";
+                string name = SelectedResults?.SelectedItem?.Result.Title ?? "";
+                if (path.Trim() == "" || name.Trim() == "") return;
+                if (File.Exists(Path.Join(path, name)))
+                {
+                    explorerPlugin.Plugin.RenameDialog(new FileInfo(Path.Join(path, name)), App.API);
+                    return;
+                }
+                if (Directory.Exists(path))
+                {
+                    explorerPlugin.Plugin.RenameDialog(new DirectoryInfo(path), App.API); // this feels kinda hacky
+                    return;
+                }
+
+
+
+
+            }
+        }
+        #endregion
+
         #endregion
 
         #region Preview
@@ -1011,6 +1070,7 @@ private void TogglePreview()
                 _ = ShowPreviewAsync();
             }
         }
+
 
         private async Task OpenExternalPreviewAsync(string path, bool sendFailToast = true)
         {

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

@@ -10,6 +10,8 @@
 using Flow.Launcher.Plugin.Explorer.Search.QuickAccessLinks;
 using Flow.Launcher.Plugin.Explorer.Helper;
 using Flow.Launcher.Plugin.Explorer.ViewModels;
+using Flow.Launcher.Plugin.Explorer.Views;
+using System.Windows.Controls;
 
 namespace Flow.Launcher.Plugin.Explorer
 {
@@ -188,6 +190,35 @@ public List<Result> LoadContextMenus(Result selectedResult)
                     IcoPath = icoPath,
                     Glyph = new GlyphInfo(FontFamily: "/Resources/#Segoe Fluent Icons", Glyph: "\uf12b")
                 });
+                contextMenus.Add(new Result
+                {
+                    Title = Context.API.GetTranslation("plugin_explorer_rename_a_file"),
+                    SubTitle = Context.API.GetTranslation("plugin_explorer_rename_subtitle"),
+                    Action = _ =>
+                    {
+                        RenameFile window;
+                        switch (record.Type)
+                        {
+                            case ResultType.Folder:
+                                window = new RenameFile(Context.API, new DirectoryInfo(record.FullPath));
+                                break;
+                            case ResultType.File:
+                                window = new RenameFile(Context.API, new FileInfo(record.FullPath));
+                                break;
+                            default:
+                                Context.API.ShowMsgError(Context.API.GetTranslation("plugin_explorer_cannot_rename"));
+                                return false;
+                        }
+                        window.ShowDialog();
+
+                        return false;
+
+                    },
+                    // placeholder until real image is found
+                    IcoPath = Constants.ShowContextMenuImagePath,
+                    Glyph = new GlyphInfo(FontFamily: "/Resources/#Segoe Fluent Icons", Glyph: "\ue70f")
+
+                });
 
 
                 if (record.Type is ResultType.File or ResultType.Folder)