Skip to content

Fix share completion with provider and spaces #19440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iSazonov merged 9 commits into from
Feb 25, 2025
Merged

Fix share completion with provider and spaces #19440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c053d25
Fix share completion with provider and spaces
MartinGC94 Apr 2, 2023
7e1c93a
Fix test
MartinGC94 Apr 2, 2023
ac77e8d
Merge branch 'PowerShell:master' into FixShareCompletion
MartinGC94 May 16, 2023
f631b79
Use compiled regex.
MartinGC94 May 16, 2023
efc3f92
Merge branch 'master' into FixShareCompletion
MartinGC94 May 25, 2023
b882b30
Merge branch 'master' into FixShareCompletion
iSazonov Feb 18, 2025
ec5566c
Merge branch 'PowerShell:master' into FixShareCompletion
MartinGC94 Feb 19, 2025
cca7564
Add test for share with space
MartinGC94 Feb 22, 2025
65be558
Move test to describe block with admin
MartinGC94 Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4478,14 +4478,15 @@ internal static IEnumerable<CompletionResult> CompleteFilename(CompletionContext
var wordToComplete = context.WordToComplete;
var quote = HandleDoubleAndSingleQuote(ref wordToComplete);

// First, try to match \\server\share
// support both / and \ when entering UNC paths for typing convenience (#17111)
var shareMatch = Regex.Match(wordToComplete, @"^(?:\\\\|//)([^\\/]+)(?:\\|/)([^\\/]*)$");
// Matches file shares with and without the provider name and with either slash direction.
// Avoids matching Windows device paths like \\.\CDROM0 and \\?\Volume{b8f3fc1c-5cd6-4553-91e2-d6814c4cd375}\
var shareMatch = s_shareMatch.Match(wordToComplete);
if (shareMatch.Success)
{
// Only match share names, no filenames.
var server = shareMatch.Groups[1].Value;
var sharePattern = WildcardPattern.Get(shareMatch.Groups[2].Value + "*", WildcardOptions.IgnoreCase);
var provider = shareMatch.Groups[1].Value;
var server = shareMatch.Groups[2].Value;
var sharePattern = WildcardPattern.Get(shareMatch.Groups[3].Value + "*", WildcardOptions.IgnoreCase);
var ignoreHidden = context.GetOption("IgnoreHiddenShares", @default: false);
var shares = GetFileShares(server, ignoreHidden);
if (shares.Count == 0)
Expand All @@ -4498,13 +4499,20 @@ internal static IEnumerable<CompletionResult> CompleteFilename(CompletionContext
{
if (sharePattern.IsMatch(share))
{
string shareFullPath = "\\\\" + server + "\\" + share;
if (quote != string.Empty)
string sharePath = $"\\\\{server}\\{share}";
string completionText;
if (quote == string.Empty)
{
shareFullPath = quote + shareFullPath + quote;
completionText = share.Contains(' ')
? $"'{provider}{sharePath}'"
: $"{provider}{sharePath}";
}
else
{
completionText = $"{quote}{provider}{sharePath}{quote}";
}

shareResults.Add(new CompletionResult(shareFullPath, shareFullPath, CompletionResultType.ProviderContainer, shareFullPath));
shareResults.Add(new CompletionResult(completionText, share, CompletionResultType.ProviderContainer, sharePath));
}
}

Expand Down Expand Up @@ -5155,6 +5163,10 @@ private static string NewPathCompletionText(string parent, string leaf, StringCo
return result;
}

private static readonly Regex s_shareMatch = new(
@"(^Microsoft\.PowerShell\.Core\\FileSystem::|^FileSystem::|^)(?:\\\\|//)(?![.|?])([^\\/]+)(?:\\|/)([^\\/]*)$",
RegexOptions.IgnoreCase | RegexOptions.Compiled);

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
private struct SHARE_INFO_1
{
Expand Down
16 changes: 16 additions & 0 deletions test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1931,6 +1931,10 @@ class InheritedClassTest : System.Attribute
$res.CompletionMatches[0].CompletionText | Should -BeExactly $afterTab
}

It "Tab completion UNC path with filesystem provider" -Skip:(!$IsWindows) {
$res = TabExpansion2 -inputScript 'Filesystem::\\localhost\admin'
$res.CompletionMatches[0].CompletionText | Should -BeExactly 'Filesystem::\\localhost\ADMIN$'
}

It "Tab completion for registry" -Skip:(!$IsWindows) {
$beforeTab = 'registry::HKEY_l'
Expand Down Expand Up @@ -3115,6 +3119,18 @@ function MyFunction ($param1, $param2)
}
}

Describe "TabCompletion elevated tests" -Tags CI, RequireAdminOnWindows {
It "Tab completion UNC path with spaces" -Skip:(!$IsWindows) {
$Share = New-SmbShare -Temporary -ReadAccess (whoami.exe) -Path C:\ -Name "Test Share"
$res = TabExpansion2 -inputScript '\\localhost\test'
$res.CompletionMatches[0].CompletionText | Should -BeExactly "& '\\localhost\Test Share'"
if ($null -ne $Share)
{
Remove-SmbShare -InputObject $Share -Force -Confirm:$false
}
}
}

Describe "Tab completion tests with remote Runspace" -Tags Feature,RequireAdminOnWindows {
BeforeAll {
$skipTest = -not $IsWindows
Expand Down
Loading