Add a Windows mode for native commands that allows some commands to use legacy argument passing

[JamesWTruher]

PR Summary

This PR targets a consistent default behavior between PowerShell 5 and PowerShell 7 on Windows for some executables and file types. The behavior is now update to use the legacy behavior for the following files:

• cmd.exe
• cscript.exe
• wscript.exe
• ending with .bat
• ending with .cmd
• ending with .vbs

This list is table driven, and can be easily altered. I have started with this list as I am familiar with real world issues with them.

The PSNativeArgumentPassing preference value has been expanded to include the new value Windows. When the preference variable is set to Windows the above table will be in effect, meaning that invocations of those files will automatically use the Legacy style argument passing. If the PSNativeArgumentPassing is set to either Legacy or Standard, then the additional checks will not take place.

The default behavior is now also platform specific. On Windows platforms, the default setting will be Windows and non-Windows platforms will be Standard.

PR Context

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
• Breaking changes
  • None
  • OR
  • Experimental feature(s) needed
    • Experimental feature name(s): PSNativeCommandArgumentPassing
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • Make sure you've added a new test if existing tests do not effectively test the code changed
• Tooling
  • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
  • OR
  • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
    • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
      (which runs in a different PS Host).
      • Issue filed:
    • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
      • Issue filed:
    • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
      • Issue filed:
    • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
      • Issue filed:

[SteveL-MSFT]

I believe this PR addresses part of #15143

[JamesWTruher]

@SteveL-MSFT - I think I've addressed your issues, please let me know

[SteveL-MSFT]

@JamesWTruher one comment was not addressed

[iSazonov]

No need to allocate. We can do if (filePath.EndsWith(exception, StringComparison.OrdinalIgnoreVase)) in line 1302.

[rkeithhill]

I'm not sure this is working completely for cmd.exe - ie excluding cmd.exe. preview.6 breaks the Invoke-BatchFile command we have implemented in PSCX:

PS> invoke-batchfile 'C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat' amd64
'\"C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat\"' is not recognized as an internal or external command,
operable program or batch file.

This is basically Lee Holmes old function that we have implemented in PSCX:

function Invoke-BatchFile
{
    param([string]$Path, [string]$Parameters)

    $tempFile = [IO.Path]::GetTempFileName()

    ## Store the output of cmd.exe.  We also ask cmd.exe to output
    ## the environment table after the batch file completes
    cmd.exe /c " `"$Path`" $Parameters && set " > $tempFile
    ...
}

Reverting to Legacy makes this function work again but at this rate I suspect I'll be running Legacy on all my Windows installs. :-(

[ghost]

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

[JamesWTruher]

@rkeithhill wrt the pscx issue that you mentioned. Have you tried running this branch against your scenario? This PR is supposed to automatically put the arg passing into legacy mode for cmd.exe invocations, so it should be fine (but I would really like confirmation on that). I've added validation for that very scenario, but I might have missed something.

[rkeithhill]

I built this branch and yes, that command works now while I still have the mode set to Windows:

[JamesWTruher]

@rkeithhill - excellent - the default setting for windows will be "Windows", which is the hybrid model where certain commands will run as Legacy while others will use "Standard". This should hopefully be better and allow the wacky parsing that happens for batch files, but enable more modern apps to use the new style.

[SteveL-MSFT]

Please take a look at Rob's suggestion

[SteveL-MSFT]

Reassigning to @rjmholt as @daxian-dbw is taking time off right now

[rjmholt]

Opened JamesWTruher#15 to add remaining suggested changes

[rjmholt]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 6 pipeline(s).

[ghost]

🎉v7.2.0-preview.8 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes