Add the TerminateOrphanedConsoleApps option on Windows to kill orph…

…aned console-attached process that may mess up reading from Console input (#3764)
PowerShell · Aug 9, 2023 · 4d78ce1 · 4d78ce1
1 parent 33c96af
commit 4d78ce1
Show file tree

Hide file tree

Showing 6 changed files with 474 additions and 25 deletions.
diff --git a/PSReadLine/Cmdlets.cs b/PSReadLine/Cmdlets.cs
@@ -502,6 +502,8 @@ public object ListPredictionTooltipColor
             set => _listPredictionTooltipColor = VTColorUtils.AsEscapeSequence(value);
         }
 
+        public bool TerminateOrphanedConsoleApps { get; set; }
+
         internal string _defaultTokenColor;
         internal string _commentColor;
         internal string _keywordColor;
@@ -808,6 +810,14 @@ public PredictionViewStyle PredictionViewStyle
         [Parameter]
         public Hashtable Colors { get; set; }
 
+        [Parameter]
+        public SwitchParameter TerminateOrphanedConsoleApps
+        {
+            get => _terminateOrphanedConsoleApps.GetValueOrDefault();
+            set => _terminateOrphanedConsoleApps = value;
+        }
+        internal SwitchParameter? _terminateOrphanedConsoleApps;
+
         [ExcludeFromCodeCoverage]
         protected override void EndProcessing()
         {

diff --git a/PSReadLine/Options.cs b/PSReadLine/Options.cs
@@ -6,8 +6,10 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using System.Management.Automation;
 using System.Reflection;
+using System.Runtime.InteropServices;
 using System.Threading;
 using Microsoft.PowerShell.PSReadLine;
 
@@ -167,6 +169,22 @@ private void SetOptionsInternal(SetPSReadLineOption options)
                     }
                 }
             }
+            if (options._terminateOrphanedConsoleApps.HasValue)
+            {
+                if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+                {
+                    Options.TerminateOrphanedConsoleApps = options.TerminateOrphanedConsoleApps;
+                    PlatformWindows.SetTerminateOrphanedConsoleApps(Options.TerminateOrphanedConsoleApps);
+                }
+                else
+                {
+                    throw new PlatformNotSupportedException(
+                        string.Format(
+                            CultureInfo.CurrentUICulture,
+                            PSReadLineResources.OptionNotSupportedOnNonWindows,
+                            nameof(Options.TerminateOrphanedConsoleApps)));
+                }
+            }
         }
 
         private void SetKeyHandlerInternal(string[] keys, Action<ConsoleKeyInfo?, object> handler, string briefDescription, string longDescription, ScriptBlock scriptBlock)

diff --git a/PSReadLine/PSReadLine.format.ps1xml b/PSReadLine/PSReadLine.format.ps1xml
@@ -164,6 +164,9 @@ $d = [Microsoft.PowerShell.KeyHandler]::GetGroupingDescription($_.Group)
               <ListItem>
                 <PropertyName>PredictionViewStyle</PropertyName>
               </ListItem>
+              <ListItem>
+                <PropertyName>TerminateOrphanedConsoleApps</PropertyName>
+              </ListItem>
               <ListItem>
                 <Label>CommandColor</Label>
                 <ScriptBlock>[Microsoft.PowerShell.VTColorUtils]::FormatColor($_.CommandColor)</ScriptBlock>

diff --git a/PSReadLine/PSReadLineResources.Designer.cs b/PSReadLine/PSReadLineResources.Designer.cs
diff --git a/PSReadLine/PSReadLineResources.resx b/PSReadLine/PSReadLineResources.resx
@@ -873,4 +873,7 @@ Or not saving history with:
   <data name="UpcaseWordDescription" xml:space="preserve">
     <value>Find the next word starting from the current position and then make it upper case.</value>
   </data>
+  <data name="OptionNotSupportedOnNonWindows" xml:space="preserve">
+    <value>The '{0}' option is not supported on non-Windows platforms.</value>
+  </data>
 </root>