WslUtils.cs

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Text.RegularExpressions;

namespace GitCredentialManager
{
    public enum WindowsShell
    {
        Cmd,
        PowerShell,
    }

    public static class WslUtils
    {
        private const string WslUncPrefix = @"\\wsl$\";
        private const string WslLocalHostUncPrefix = @"\\wsl.localhost\";
        private const string WslCommandName = "wsl.exe";
        private const string WslConfFilePath = "/etc/wsl.conf";
        private const string DefaultWslMountPrefix = "/mnt";
        private const string DefaultWslSysDriveMountName = "c";

        internal const string WslViewShellHandlerName = "wslview";

        /// <summary>
        /// Cached Windows host session ID.
        /// </summary>
        /// <remarks>A value less than 0 represents "unknown".</remarks>
        private static int _windowsSessionId = -1;

        /// <summary>
        /// Cached WSL version.
        /// </summary>
        /// <remarks>A value of 0 represents "not WSL", and a value less than 0 represents "unknown".</remarks>
        private static int _wslVersion = -1;

        /// <summary>
        /// Cached Windows system drive mount path.
        /// </summary>
        private static string _sysDriveMountPath = null;

        public static bool IsWslDistribution(IEnvironment env, IFileSystem fs, out int wslVersion)
        {
            if (_wslVersion < 0)
            {
                _wslVersion = GetWslVersion(env, fs);
            }

            wslVersion = _wslVersion;
            return _wslVersion > 0;
        }

        private static int GetWslVersion(IEnvironment env, IFileSystem fs)
        {
            // All WSL distributions are Linux.. obviously!
            if (!PlatformUtils.IsLinux())
            {
                return 0;
            }

            const string procWslInteropPath = "/proc/sys/fs/binfmt_misc/WSLInterop";
            const string procWslInteropLatePath = "/proc/sys/fs/binfmt_misc/WSLInterop-Late";
            // The WSLInterop file exists in WSL1 distributions  
            if (fs.FileExists(procWslInteropPath))
            {
                return 1;
            }
            // The WSLInterop-Late file exists in WSL2 distributions  
            if (fs.FileExists(procWslInteropLatePath))
            {
                return 2;
            }

            return 0;
        }

        /// <summary>
        /// Test if a file path points to a location in a Windows Subsystem for Linux distribution.
        /// </summary>
        /// <param name="path">Path to test.</param>
        /// <returns>True if <paramref name="path"/> is a WSL path, false otherwise.</returns>
        public static bool IsWslPath(string path)
        {
            if (string.IsNullOrWhiteSpace(path)) return false;

            return (path.StartsWith(WslUncPrefix, StringComparison.OrdinalIgnoreCase) &&
                    path.Length > WslUncPrefix.Length) ||
                   (path.StartsWith(WslLocalHostUncPrefix, StringComparison.OrdinalIgnoreCase) &&
                    path.Length > WslLocalHostUncPrefix.Length);
        }

        /// <summary>
        /// Create a command to be executed in a Windows Subsystem for Linux distribution.
        /// </summary>
        /// <param name="distribution">WSL distribution name.</param>
        /// <param name="command">Command to execute.</param>
        /// <param name="trace2">The applications TRACE2 tracer.</param>
        /// <param name="workingDirectory">Optional working directory.</param>
        /// <returns><see cref="Process"/> object ready to start.</returns>
        public static ChildProcess CreateWslProcess(string distribution,
            string command,
            ITrace2 trace2,
            string workingDirectory = null)
        {
            var args = new StringBuilder();
            args.AppendFormat("--distribution {0} ", distribution);
            args.AppendFormat("--exec {0}", command);

            string wslExePath = GetWslPath();

            var psi = new ProcessStartInfo(wslExePath, args.ToString())
            {
                RedirectStandardInput = true,
                RedirectStandardOutput = true,
                RedirectStandardError = false, // Do not redirect stderr as tracing might be enabled
                UseShellExecute = false,
                WorkingDirectory = workingDirectory ?? string.Empty
            };

            return new ChildProcess(trace2, psi);
        }

        /// <summary>
        /// Create a command to be executed in a shell in the host Windows operating system.
        /// </summary>
        /// <param name="fs">File system.</param>
        /// <param name="shell">Shell used to execute the command in Windows.</param>
        /// <param name="command">Command to execute.</param>
        /// <param name="workingDirectory">Optional working directory.</param>
        /// <returns><see cref="Process"/> object ready to start.</returns>
        public static Process CreateWindowsShellProcess(IFileSystem fs,
            WindowsShell shell, string command, string workingDirectory = null)
        {
            string sysDrive = GetSystemDriveMountPath(fs);

            string launcher;
            var args = new StringBuilder();

            switch (shell)
            {
                case WindowsShell.Cmd:
                    launcher = Path.Combine(sysDrive, "Windows/cmd.exe");
                    args.AppendFormat("/C {0}", command);
                    break;

                case WindowsShell.PowerShell:
                    const string psStreamSetup =
                        "[Console]::OutputEncoding = [System.Text.Encoding]::UTF8; " +
                        "[Console]::InputEncoding = [System.Text.Encoding]::UTF8; ";

                    launcher = Path.Combine(sysDrive, "Windows/System32/WindowsPowerShell/v1.0/powershell.exe");
                    args.Append(" -NoProfile -NonInteractive -ExecutionPolicy Bypass");
                    args.AppendFormat(" -Command \"{0} {1}\"", psStreamSetup, command);
                    break;

                default:
                    throw new ArgumentOutOfRangeException(nameof(shell));
            }

            var psi = new ProcessStartInfo(launcher, args.ToString())
            {
                RedirectStandardInput = true,
                RedirectStandardOutput = true,
                RedirectStandardError = true,
                UseShellExecute = false,
                WorkingDirectory = workingDirectory ?? string.Empty
            };

            return new Process { StartInfo = psi };
        }

        /// <summary>
        /// Get the host Windows session ID.
        /// </summary>
        /// <returns>Windows session ID, or a negative value if it is not known.</returns>
        public static int GetWindowsSessionId(IFileSystem fs)
        {
            if (_windowsSessionId < 0)
            {
                const string script = @"(Get-Process -ID $PID).SessionId";
                using (Process proc = CreateWindowsShellProcess(fs, WindowsShell.PowerShell, script))
                {
                    proc.Start();
                    proc.WaitForExit();

                    if (proc.ExitCode == 0)
                    {
                        string output = proc.StandardOutput.ReadToEnd().Trim();
                        if (int.TryParse(output, out int sessionId))
                        {
                            _windowsSessionId = sessionId;
                        }
                    }
                }
            }

            return _windowsSessionId;
        }

        private static string GetSystemDriveMountPath(IFileSystem fs)
        {
            if (_sysDriveMountPath is null)
            {
                string mountPrefix = DefaultWslMountPrefix;

                // If the wsl.conf file exists in this distribution the user may
                // have changed the Windows volume mount point prefix. Use it!
                if (fs.FileExists(WslConfFilePath))
                {
                    // Read wsl.conf for [automount] root = <path>
                    IniFile wslConf = IniSerializer.Deserialize(fs, WslConfFilePath);
                    if (wslConf.TryGetSection("automount", out IniSection automountSection) &&
                        automountSection.TryGetProperty("root", out string value))
                    {
                        mountPrefix = value;
                    }
                }

                // Try to locate the system volume by looking for the Windows\System32 directory
                IEnumerable<string> mountPoints = fs.EnumerateDirectories(mountPrefix);
                foreach (string mountPoint in mountPoints)
                {
                    string sys32Path = Path.Combine(mountPoint, "Windows", "System32");

                    if (fs.DirectoryExists(sys32Path))
                    {
                        _sysDriveMountPath = mountPoint;
                        return _sysDriveMountPath;
                    }
                }

                _sysDriveMountPath = Path.Combine(mountPrefix, DefaultWslSysDriveMountName);
            }

            return _sysDriveMountPath;
        }

        public static string ConvertToDistroPath(string path, out string distribution)
        {
            if (!IsWslPath(path)) throw new ArgumentException("Must provide a WSL path", nameof(path));

            int distroStart;
            if (path.StartsWith(WslUncPrefix, StringComparison.OrdinalIgnoreCase))
            {
                distroStart = WslUncPrefix.Length;
            }
            else if (path.StartsWith(WslLocalHostUncPrefix, StringComparison.OrdinalIgnoreCase))
            {
                distroStart = WslLocalHostUncPrefix.Length;
            }
            else
            {
                throw new Exception("Invalid WSL path prefix");
            }

            int distroEnd = path.IndexOf('\\', distroStart);

            if (distroEnd < 0) distroEnd = path.Length;

            distribution = path.Substring(distroStart, distroEnd - distroStart);

            if (path.Length > distroEnd)
            {
                return path.Substring(distroEnd).Replace('\\', '/');
            }

            return "/";
        }

        internal /*for testing purposes*/ static string GetWslPath()
        {
            // WSL is only supported on 64-bit operating systems
            if (!Environment.Is64BitOperatingSystem)
            {
                throw new Exception("WSL is not supported on 32-bit operating systems");
            }

            //
            // When running as a 32-bit application on a 64-bit operating system, we cannot access the real
            // C:\Windows\System32 directory because the OS will redirect us transparently to the
            // C:\Windows\SysWOW64 directory (containing 32-bit executables).
            //
            // In order to access the real 64-bit System32 directory, we must access via the pseudo directory
            // C:\Windows\SysNative that does **not** experience any redirection for 32-bit applications.
            //
            // HOWEVER, if we're running as a 64-bit application on a 64-bit operating system, the SysNative
            // directory does not exist! This means if running as a 64-bit application on a 64-bit OS we must
            // use the System32 directory name directly.
            //
            var sysDir = Environment.ExpandEnvironmentVariables(
                Environment.Is64BitProcess
                    ? @"%WINDIR%\System32"
                    : @"%WINDIR%\SysNative"
            );

            return Path.Combine(sysDir, WslCommandName);
        }
    }
}