codeql/csharp/extractor/Semmle.Extraction.CSharp.Standalone/Runtime.cs

using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;
using Semmle.BuildAnalyser;
using Semmle.Util;

namespace Semmle.Extraction.CSharp.Standalone
{
    /// <summary>
    /// Locates .NET Runtimes.
    /// </summary>
    internal partial class Runtime
    {
        private const string netCoreApp = "Microsoft.NETCore.App";
        private const string aspNetCoreApp = "Microsoft.AspNetCore.App";

        private readonly IDotNet dotNet;
        private readonly Lazy<Dictionary<string, RuntimeVersion>> newestRuntimes;
        private Dictionary<string, RuntimeVersion> NewestRuntimes => newestRuntimes.Value;
        private static string ExecutingRuntime => RuntimeEnvironment.GetRuntimeDirectory();

        public Runtime(IDotNet dotNet)
        {
            this.dotNet = dotNet;
            this.newestRuntimes = new(GetNewestRuntimes);
        }

        internal record RuntimeVersion : IComparable<RuntimeVersion>
        {
            private readonly string dir;
            private readonly Version version;
            private readonly Version? preReleaseVersion;
            private readonly string? preReleaseVersionType;
            private bool IsPreRelease => preReleaseVersionType is not null && preReleaseVersion is not null;
            public string FullPath
            {
                get
                {
                    var preRelease = IsPreRelease ? $"-{preReleaseVersionType}.{preReleaseVersion}" : "";
                    var version = this.version + preRelease;
                    return Path.Combine(dir, version);
                }
            }

            public RuntimeVersion(string dir, string version, string preReleaseVersionType, string preReleaseVersion)
            {
                this.dir = dir;
                this.version = Version.Parse(version);
                if (!string.IsNullOrEmpty(preReleaseVersion) && !string.IsNullOrEmpty(preReleaseVersionType))
                {
                    this.preReleaseVersionType = preReleaseVersionType;
                    this.preReleaseVersion = Version.Parse(preReleaseVersion);
                }
            }

            public int CompareTo(RuntimeVersion? other)
            {
                var c = version.CompareTo(other?.version);
                if (c == 0 && IsPreRelease)
                {
                    if (!other!.IsPreRelease)
                    {
                        return -1;
                    }

                    // Both are pre-release like runtime versions.
                    // The pre-release version types are sorted alphabetically (e.g. alpha, beta, preview, rc)
                    // and the pre-release version types are more important that the pre-release version numbers.
                    return preReleaseVersionType != other!.preReleaseVersionType
                        ? preReleaseVersionType!.CompareTo(other!.preReleaseVersionType)
                        : preReleaseVersion!.CompareTo(other!.preReleaseVersion);
                }

                return c;
            }

            public override string ToString() => FullPath;
        }

        [GeneratedRegex(@"^(\S+)\s(\d+\.\d+\.\d+)(-([a-z]+)\.(\d+\.\d+\.\d+))?\s\[(.+)\]$")]
        private static partial Regex RuntimeRegex();

        /// <summary>
        /// Parses the output of `dotnet --list-runtimes` to get a map from a runtime to the location of
        /// the newest version of the runtime.
        /// It is assume that the format of a listed runtime is something like:
        /// Microsoft.NETCore.App 7.0.2 [/usr/share/dotnet/shared/Microsoft.NETCore.App]
        /// </summary>
        private static Dictionary<string, RuntimeVersion> ParseRuntimes(IList<string> listed)
        {
            // Parse listed runtimes.
            var runtimes = new Dictionary<string, RuntimeVersion>();
            listed.ForEach(r =>
            {
                var match = RuntimeRegex().Match(r);
                if (match.Success)
                {
                    runtimes.AddOrUpdateToLatest(match.Groups[1].Value, new RuntimeVersion(match.Groups[6].Value, match.Groups[2].Value, match.Groups[4].Value, match.Groups[5].Value));
                }
            });

            return runtimes;
        }

        /// <summary>
        /// Returns a dictionary mapping runtimes to their newest version.
        /// </summary>
        internal Dictionary<string, RuntimeVersion> GetNewestRuntimes()
        {
            var listed = dotNet.GetListedRuntimes();
            return ParseRuntimes(listed);
        }

        /// <summary>
        /// Locates .NET Desktop Runtimes.
        /// This includes Mono and Microsoft.NET.
        /// </summary>
        private static IEnumerable<string> DesktopRuntimes
        {
            get
            {
                var monoPath = FileUtils.FindProgramOnPath(Win32.IsWindows() ? "mono.exe" : "mono");
                var monoDirs = monoPath is not null
                    ? new[] { monoPath }
                    : new[] { "/usr/lib/mono", @"C:\Program Files\Mono\lib\mono" };

                if (Directory.Exists(@"C:\Windows\Microsoft.NET\Framework64"))
                {
                    return Directory.EnumerateDirectories(@"C:\Windows\Microsoft.NET\Framework64", "v*")
                        .OrderByDescending(Path.GetFileName);
                }

                var dir = monoDirs.FirstOrDefault(Directory.Exists);

                if (dir is not null)
                {
                    return Directory.EnumerateDirectories(dir)
                        .Where(d => Char.IsDigit(Path.GetFileName(d)[0]))
                        .OrderByDescending(Path.GetFileName);
                }

                return Enumerable.Empty<string>();
            }
        }

        /// <summary>
        /// Gets the .NET runtime location to use for extraction.
        /// </summary>
        public string GetRuntime(bool useSelfContained)
        {
            if (useSelfContained)
            {
                return ExecutingRuntime;
            }

            // Location of the newest .NET Core Runtime.
            if (NewestRuntimes.TryGetValue(netCoreApp, out var netCoreVersion))
            {
                return netCoreVersion.FullPath;
            }

            if (DesktopRuntimes.Any())
            {
                return DesktopRuntimes.First();
            }

            // A bad choice if it's the self-contained runtime distributed in codeql dist.
            return ExecutingRuntime;
        }

        /// <summary>
        /// Gets the ASP.NET runtime location to use for extraction, if one exists.
        /// </summary>
        public string? GetAspRuntime()
        {
            // Location of the newest ASP.NET Core Runtime.
            if (NewestRuntimes.TryGetValue(aspNetCoreApp, out var aspNetCoreVersion))
            {
                return aspNetCoreVersion.FullPath;
            }
            return null;
        }
    }
}