Allow user scripts to operate on selected files (#11239)

GitCommands/StringExtensions.cs

@@ -1,6 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Diagnostics.Contracts;
 using System.Text;
+using GitCommands.Utils;
 using GitExtUtils;
 
 // ReSharper disable once CheckNamespace
@@ -189,6 +190,18 @@ public static string Quote(this string? s, string q = "\"")
             return string.IsNullOrEmpty(s) ? s : s.Quote();
         }
 
+        /// <summary>
+        /// Quotes and escapes this string for use as a command line argument.
+        /// </summary>
+        [Pure]
+        public static string QuoteForCommandLine(this string s, bool? forWindows = null)
+        {
+            return $"\"{((forWindows ?? EnvUtils.RunningOnWindows()) ? EscapeForWindowsCommandLine(s) : EscapeForPosixCommandLine(s))}\"";
+
+            static string EscapeForWindowsCommandLine(string s) => s.Replace("\"", "\"\"");
+            static string EscapeForPosixCommandLine(string s) => s.Replace(@"\", @"\\").Replace("\"", "\\\"").Replace("'", @"\'");
+        }
+
         /// <summary>
         /// Adds parentheses if string is not null and not empty.
         /// </summary>

GitUI/CommandsDialogs/FormCommit.cs

@@ -404,6 +404,8 @@ void AddToSelectionFilter()
                         }
                     });
 
+            UICommands.PostRepositoryChanged += UICommands_PostRepositoryChanged;
+
             return;
 
             void ConfigureMessageBox()
@@ -430,6 +432,11 @@ protected override void Dispose(bool disposing)
         {
             if (disposing)
             {
+                if (!IsDesignMode && !IsUnitTestActive)
+                {
+                    UICommands.PostRepositoryChanged -= UICommands_PostRepositoryChanged;
+                }
+
                 _unstagedLoader.Dispose();
                 _customDiffToolsSequence.Dispose();
                 _interactiveAddSequence.Dispose();
@@ -601,6 +608,20 @@ protected override void OnKeyUp(KeyEventArgs e)
             return;
         }
 
+        protected override void OnUICommandsChanged(GitUICommandsChangedEventArgs e)
+        {
+            GitUICommands oldCommands = e.OldCommands;
+
+            if (oldCommands is not null)
+            {
+                oldCommands.PostRepositoryChanged -= UICommands_PostRepositoryChanged;
+            }
+
+            UICommands.PostRepositoryChanged += UICommands_PostRepositoryChanged;
+
+            base.OnUICommandsChanged(e);
+        }
+
         public override bool ProcessHotkey(Keys keyData)
         {
             if (IsDesignMode || !HotkeysEnabled)
@@ -889,6 +910,11 @@ protected override bool ExecuteCommand(int cmd)
             }
         }
 
+        public override IScriptOptionsProvider? GetScriptOptionsProvider()
+        {
+            return new ScriptOptionsProvider(_currentFilesList, () => _fullPathResolver, () => SelectedDiff.CurrentFileLine);
+        }
+
         #endregion
 
         private void ComputeUnstagedFiles(Action<IReadOnlyList<GitItemStatus>> onComputed, bool doAsync)
@@ -1647,6 +1673,8 @@ private void UnstagedFileContext_Opening(object sender, System.ComponentModel.Ca
             openWithToolStripMenuItem.Enabled = !isAnyDeleted;
             deleteFileToolStripMenuItem.Enabled = !isAnyDeleted;
             openContainingFolderToolStripMenuItem.Enabled = !isAnyDeleted;
+
+            UnstagedFileContext.AddUserScripts(runScriptToolStripMenuItem, ExecuteCommand, script => script.OnEvent == ScriptEvent.ShowInFileList, UICommands);
         }
 
         private void StagedFileContext_Opening(object sender, System.ComponentModel.CancelEventArgs e)
@@ -1666,6 +1694,8 @@ private void StagedFileContext_Opening(object sender, System.ComponentModel.Canc
             stagedOpenToolStripMenuItem7.Enabled = !isAnyDeleted;
             stagedOpenWithToolStripMenuItem8.Enabled = !isAnyDeleted;
             stagedOpenFolderToolStripMenuItem10.Enabled = !isAnyDeleted;
+
+            StagedFileContext.AddUserScripts(stagedRunScriptToolStripMenuItem, ExecuteCommand, script => script.OnEvent == ScriptEvent.ShowInFileList, UICommands);
         }
 
         private void UnstagedSubmoduleContext_Opening(object sender, System.ComponentModel.CancelEventArgs e)
@@ -3463,6 +3493,18 @@ private void UpdateButtonStates()
                 : TranslatedStrings.ButtonPush;
         }
 
+        private void UICommands_PostRepositoryChanged(object sender, GitUIEventArgs e)
+        {
+            if (!_skipUpdate && !_bypassActivatedEventHandler)
+            {
+                ThreadHelper.FileAndForget(async () =>
+                    {
+                        await this.SwitchToMainThreadAsync();
+                        RescanChanges();
+                    });
+            }
+        }
+
         internal TestAccessor GetTestAccessor()
             => new(this);
 

GitUI/CommandsDialogs/RevisionDiffControl.cs

@@ -5,6 +5,7 @@
 using GitUI.CommandDialogs;
 using GitUI.CommandsDialogs.BrowseDialog;
 using GitUI.HelperDialogs;
+using GitUI.ScriptsEngine;
 using GitUI.UserControls;
 using GitUI.UserControls.RevisionGrid;
 using GitUIPluginInterfaces;
@@ -188,6 +189,11 @@ bool SelectFirstGroupChangesIfFileNotFocused()
             }
         }
 
+        protected override IScriptOptionsProvider? GetScriptOptionsProvider()
+        {
+            return new ScriptOptionsProvider(DiffFiles, () => _fullPathResolver, () => BlameControl.Visible ? BlameControl.CurrentFileLine : DiffText.CurrentFileLine);
+        }
+
         public void ReloadHotkeys()
         {
             LoadHotkeys(HotkeySettingsName);
@@ -747,6 +753,8 @@ private void UpdateStatusOfMenuItems()
             {
                 blameToolStripMenuItem.Checked = false;
             }
+
+            DiffContextMenu.AddUserScripts(runScriptToolStripMenuItem, ExecuteCommand, script => script.OnEvent == ScriptEvent.ShowInFileList, UICommands);
         }
 
         private void DiffContextMenu_Opening(object sender, CancelEventArgs e)

GitUI/CommandsDialogs/RevisionFileTreeControl.cs

@@ -7,6 +7,7 @@
 using GitUI.CommandDialogs;
 using GitUI.CommandsDialogs.BrowseDialog;
 using GitUI.Properties;
+using GitUI.ScriptsEngine;
 using GitUI.UserControls;
 using GitUIPluginInterfaces;
 using Microsoft;
@@ -290,6 +291,21 @@ protected override bool ExecuteCommand(int cmd)
             return true;
         }
 
+        protected override IScriptOptionsProvider? GetScriptOptionsProvider()
+        {
+            return new ScriptOptionsProvider(() =>
+                {
+                    if (tvGitTree.SelectedNode?.Tag is not GitItem gitItem || gitItem.ObjectType != GitObjectType.Blob)
+                    {
+                        return Array.Empty<string>();
+                    }
+
+                    return new string[] { gitItem.FileName };
+                },
+                () => _fullPathResolver,
+                () => BlameControl.Visible ? BlameControl.CurrentFileLine : FileText.CurrentFileLine);
+        }
+
         public override bool ProcessHotkey(Keys keyData)
         {
             return base.ProcessHotkey(keyData)
@@ -733,6 +749,8 @@ private void FileTreeContextMenu_Opening(object sender, System.ComponentModel.Ca
             findToolStripMenuItem.Enabled = tvGitTree.Nodes.Count > 0;
             expandToolStripMenuItem.Visible = isFolder;
             collapseAllToolStripMenuItem.Visible = isFolder;
+
+            FileTreeContextMenu.AddUserScripts(runScriptToolStripMenuItem, ExecuteCommand, script => script.OnEvent == ScriptEvent.ShowInFileList, UICommands);
         }
 
         private void fileTreeOpenContainingFolderToolStripMenuItem_Click(object sender, EventArgs e)