Merge pull request #3703 from mrixner/select-executables

Author: marticliment

src/UniGetUI.Core.Data/CoreData.cs

@@ -390,5 +390,6 @@ private static int GetCodePage()
             }
         }
 
+        public static readonly string PowerShell5 = Path.Join(Environment.SystemDirectory, "windowspowershell\\v1.0\\powershell.exe");
     }
 }

src/UniGetUI.Core.SecureSettings/SecureSettings.cs

@@ -14,6 +14,7 @@ public enum K
         AllowPrePostOpCommand,
         AllowImportPrePostOpCommands,
         ForceUserGSudo,
+        AllowCustomManagerPaths,
         Unset
     };
 
@@ -26,6 +27,7 @@ public static string ResolveKey(K key)
             K.AllowPrePostOpCommand => "AllowPrePostInstallCommands",
             K.AllowImportPrePostOpCommands => "AllowImportingPrePostInstallCommands",
             K.ForceUserGSudo => "ForceUserGSudo",
+            K.AllowCustomManagerPaths => "AllowCustomManagerPaths",
 
             K.Unset => throw new InvalidDataException("SecureSettings key was unset!"),
             _ => throw new KeyNotFoundException($"The SecureSettings key {key} was not found on the ResolveKey map")

src/UniGetUI.Core.Settings/SettingsEngine_Names.cs

@@ -75,6 +75,7 @@ public enum K
         DisableSuccessNotifications,
         DisableProgressNotifications,
         KillProcessesThatRefuseToDie,
+        ManagerPaths,
 
         Test1,
         Test2,
@@ -161,6 +162,7 @@ public static string ResolveKey(K key)
             K.DisableSuccessNotifications => "DisableSuccessNotifications",
             K.DisableProgressNotifications => "DisableProgressNotifications",
             K.KillProcessesThatRefuseToDie => "KillProcessesThatRefuseToDie",
+            K.ManagerPaths => "ManagerPaths",
 
             K.Test1 => "TestSetting1",
             K.Test2 => "TestSetting2",

src/UniGetUI.Core.Tools/Tools.cs

@@ -103,13 +103,13 @@ public static void RelaunchProcess()
         /// Finds an executable in path and returns its location
         /// </summary>
         /// <param name="command">The executable alias to find</param>
-        /// <returns>A tuple containing: a boolean hat represents whether the path was found or not; the path to the file if found.</returns>
+        /// <returns>A tuple containing: a boolean that represents whether the path was found or not; the path to the file if found.</returns>
         public static async Task<Tuple<bool, string>> WhichAsync(string command)
         {
             return await Task.Run(() => Which(command));
         }
 
-        public static Tuple<bool, string> Which(string command, bool updateEnv = true)
+        public static List<string> WhichMultiple(string command, bool updateEnv = true)
         {
             command = command.Replace(";", "").Replace("&", "").Trim();
             Logger.Debug($"Begin \"which\" search for command {command}");
@@ -142,30 +142,36 @@ public static Tuple<bool, string> Which(string command, bool updateEnv = true)
             try
             {
                 process.Start();
-                string? line = process.StandardOutput.ReadLine();
-                string output;
-
-                if (line is null) output = "";
-                else output = line.Trim();
+                string[] lines = process.StandardOutput.ReadToEnd()
+                    .Split(["\r\n", "\n"], StringSplitOptions.RemoveEmptyEntries);
 
                 process.WaitForExit();
 
-                if (process.ExitCode != 0 || output == "")
+                if (process.ExitCode is not 0)
+                    Logger.Warn($"Call to WhichMultiple with file {command} returned non-zero status {process.ExitCode}");
+
+                if (lines.Length is 0)
                 {
                     Logger.ImportantInfo($"Command {command} was not found on the system");
-                    return new Tuple<bool, string>(false, "");
+                    return [];
                 }
 
-                Logger.Debug($"Command {command} was found on {output}");
-                return new Tuple<bool, string>(File.Exists(output), output);
+                Logger.Debug($"Command {command} was found on {lines[0]} (with {lines.Length-1} more occurrences)");
+                return lines.ToList();
             }
             catch
             {
-                if (updateEnv) return Which(command, false);
+                if (updateEnv) return WhichMultiple(command, false);
                 throw;
             }
         }
 
+        public static Tuple<bool, string> Which(string command, bool updateEnv = true)
+        {
+            var paths = WhichMultiple(command, updateEnv);
+            return new(paths.Any(), paths.Any() ? paths[0]: "");
+        }
+
         /// <summary>
         /// Formats a given package id as a name, capitalizing words and replacing separators with spaces
         /// </summary>

src/UniGetUI.PAckageEngine.Interfaces/IPackageManager.cs

@@ -68,5 +68,13 @@ public interface IPackageManager
         /// an example
         /// </summary>
         public void AttemptFastRepair();
+
+        /// <summary>
+        /// Find all available executable files that apply to this package manager
+        /// </summary>
+        /// <returns></returns>
+        public IReadOnlyList<string> FindCandidateExecutableFiles();
+        public Tuple<bool, string> GetExecutableFile();
+
     }
 }

src/UniGetUI.PAckageEngine.Interfaces/ManagerProperties.cs

@@ -11,7 +11,7 @@ public struct ManagerProperties
         public string Description { get; set; } = "Unset";
         public IconType IconId { get; set; } = IconType.Help;
         public string ColorIconId { get; set; } = "Unset";
-        public string ExecutableCallArgs { get; set; } = "Unset";
+        // public string ExecutableCallArgs { get; set; } = "Unset";
         public string ExecutableFriendlyName { get; set; } = "Unset";
         public string InstallVerb { get; set; } = "Unset";
         public string UpdateVerb { get; set; } = "Unset";

src/UniGetUI.PackageEngine.Enums/ManagerStatus.cs

@@ -5,6 +5,7 @@ public struct ManagerStatus
         public string Version = "";
         public bool Found = false;
         public string ExecutablePath = "";
+        public string ExecutableCallArgs { get; set; } = "Unset";
         public ManagerStatus()
         { }
     }

src/UniGetUI.PackageEngine.Managers.Cargo/Cargo.cs

@@ -2,6 +2,7 @@
 using System.Text;
 using System.Text.RegularExpressions;
 using UniGetUI.Core.Classes;
+using UniGetUI.Core.Data;
 using UniGetUI.Core.Logging;
 using UniGetUI.Core.Tools;
 using UniGetUI.PackageEngine.Classes.Manager;
@@ -29,14 +30,14 @@ public Cargo()
             // cargo-update is required to check for installed and upgradable packages
             new ManagerDependency(
                 "cargo-update",
-                Path.Join(Environment.SystemDirectory, "windowspowershell\\v1.0\\powershell.exe"),
+                CoreData.PowerShell5,
                 "-ExecutionPolicy Bypass -NoLogo -NoProfile -Command \"& {cargo install cargo-update; if ($error.count -ne 0){pause}}\"",
                 "cargo install cargo-update",
                 async () => (await CoreTools.WhichAsync("cargo-install-update.exe")).Item1),
             // Cargo-binstall is required to install and update cargo binaries
             new ManagerDependency(
                 "cargo-binstall",
-                Path.Join(Environment.SystemDirectory, "windowspowershell\\v1.0\\powershell.exe"),
+                CoreData.PowerShell5,
                 "-ExecutionPolicy Bypass -NoLogo -NoProfile -Command \"& {Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr \\\"https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.ps1\\\").Content; if ($error.count -ne 0){pause}}\"",
                 "Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr \"https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.ps1\").Content",
                 async () => (await CoreTools.WhichAsync("cargo-binstall.exe")).Item1)
@@ -64,7 +65,6 @@ public Cargo()
             InstallVerb = "binstall",
             UninstallVerb = "uninstall",
             UpdateVerb = "binstall",
-            ExecutableCallArgs = "",
             DefaultSource = cratesIo,
             KnownSources = [cratesIo]
         };
@@ -136,9 +136,14 @@ protected override IReadOnlyList<Package> GetInstalledPackages_UnSafe()
         return GetPackages(LoggableTaskType.ListInstalledPackages);
     }
 
+    public override IReadOnlyList<string> FindCandidateExecutableFiles()
+    {
+        return CoreTools.WhichMultiple("cargo.exe");
+    }
+
     protected override ManagerStatus LoadManager()
     {
-        var (found, executablePath) = CoreTools.Which("cargo");
+        var (found, executablePath) = GetExecutableFile();
         if (!found)
         {
             return new(){ ExecutablePath = executablePath, Found = false, Version = ""};
@@ -153,7 +158,7 @@ protected override ManagerStatus LoadManager()
             Logger.Error("cargo version error: " + error);
         }
 
-        return new() { ExecutablePath = executablePath, Found = found, Version = version };
+        return new() { ExecutablePath = executablePath, Found = found, Version = version, ExecutableCallArgs = ""};
     }
 
     private IReadOnlyList<Package> GetPackages(LoggableTaskType taskType)
@@ -204,7 +209,7 @@ private Process GetProcess(string fileName, string extraArguments)
             StartInfo = new ProcessStartInfo
             {
                 FileName = fileName,
-                Arguments = Properties.ExecutableCallArgs + " " + extraArguments,
+                Arguments = Status.ExecutableCallArgs + " " + extraArguments,
                 RedirectStandardOutput = true,
                 RedirectStandardError = true,
                 UseShellExecute = false,

src/UniGetUI.PackageEngine.Managers.Chocolatey/Chocolatey.cs

@@ -18,8 +18,10 @@ namespace UniGetUI.PackageEngine.Managers.ChocolateyManager
 {
     public class Chocolatey : BaseNuGet
     {
-        public static new string[] FALSE_PACKAGE_IDS = ["Directory", "", "Did", "Features?", "Validation", "-", "being", "It", "Error", "L'accs", "Maximum", "This", "Output is package name ", "operable", "Invalid"];
-        public static new string[] FALSE_PACKAGE_VERSIONS = ["", "of", "Did", "Features?", "Validation", "-", "being", "It", "Error", "L'accs", "Maximum", "This", "packages", "current version", "installed version", "is", "program", "validations", "argument", "no"];
+        public static readonly string[] FALSE_PACKAGE_IDS = ["Directory", "", "Did", "Features?", "Validation", "-", "being", "It", "Error", "L'accs", "Maximum", "This", "Output is package name ", "operable", "Invalid"];
+        public static readonly string[] FALSE_PACKAGE_VERSIONS = ["", "of", "Did", "Features?", "Validation", "-", "being", "It", "Error", "L'accs", "Maximum", "This", "packages", "current version", "installed version", "is", "program", "validations", "argument", "no"];
+        private static readonly string OldChocoPath = Path.Join(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Programs\\WingetUI\\choco-cli");
+        private static readonly string NewChocoPath = Path.Join(CoreData.UniGetUIDataDirectory, "Chocolatey");
 
         public Chocolatey()
         {
@@ -54,7 +56,6 @@ public Chocolatey()
                 InstallVerb = "install",
                 UninstallVerb = "uninstall",
                 UpdateVerb = "upgrade",
-                ExecutableCallArgs = "",
                 KnownSources = [new ManagerSource(this, "community", new Uri("https://community.chocolatey.org/api/v2/"))],
                 DefaultSource = new ManagerSource(this, "community", new Uri("https://community.chocolatey.org/api/v2/")),
 
@@ -75,7 +76,7 @@ public static string GetProxyArgument()
                 return $"--proxy {proxyUri.ToString()}";
 
             var creds = Settings.GetProxyCredentials();
-            if(creds is null)
+            if (creds is null)
                 return $"--proxy {proxyUri.ToString()}";
 
             return $"--proxy={proxyUri.ToString()} --proxy-user={Uri.EscapeDataString(creds.UserName)}" +
@@ -89,7 +90,7 @@ protected override IReadOnlyList<Package> GetAvailableUpdates_UnSafe()
                 StartInfo = new ProcessStartInfo
                 {
                     FileName = Status.ExecutablePath,
-                    Arguments = Properties.ExecutableCallArgs + " outdated " + GetProxyArgument(),
+                    Arguments = Status.ExecutableCallArgs + " outdated " + GetProxyArgument(),
                     RedirectStandardOutput = true,
                     RedirectStandardError = true,
                     RedirectStandardInput = true,
@@ -143,7 +144,7 @@ protected override IReadOnlyList<Package> _getInstalledPackages_UnSafe()
                 StartInfo = new ProcessStartInfo
                 {
                     FileName = Status.ExecutablePath,
-                    Arguments = Properties.ExecutableCallArgs + " list " + GetProxyArgument(),
+                    Arguments = Status.ExecutableCallArgs + " list " + GetProxyArgument(),
                     RedirectStandardOutput = true,
                     RedirectStandardError = true,
                     RedirectStandardInput = true,
@@ -190,18 +191,25 @@ protected override IReadOnlyList<Package> _getInstalledPackages_UnSafe()
             return Packages;
         }
 
-        protected override ManagerStatus LoadManager()
+        public override IReadOnlyList<string> FindCandidateExecutableFiles()
         {
-            ManagerStatus status = new();
+            List<string> candidates = [];
 
-            string old_choco_path = Path.Join(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Programs\\WingetUI\\choco-cli");
-            string new_choco_path = Path.Join(CoreData.UniGetUIDataDirectory, "Chocolatey");
+            if (!Settings.Get(Settings.K.UseSystemChocolatey))
+            {
+                candidates.Add(Path.Join(NewChocoPath, "choco.exe"));
+            }
+            candidates.AddRange(CoreTools.WhichMultiple("choco.exe"));
+            return candidates;
+        }
 
-            if (!Directory.Exists(old_choco_path))
+        protected override ManagerStatus LoadManager()
+        {
+            if (!Directory.Exists(OldChocoPath))
             {
                 Logger.Debug("Old chocolatey path does not exist, not migrating Chocolatey");
             }
-            else if (CoreTools.IsSymbolicLinkDir(old_choco_path))
+            else if (CoreTools.IsSymbolicLinkDir(OldChocoPath))
             {
                 Logger.ImportantInfo("Old chocolatey path is a symbolic link, not migrating Chocolatey...");
             }
@@ -217,20 +225,20 @@ protected override ManagerStatus LoadManager()
 
                     string current_env_var =
                         Environment.GetEnvironmentVariable("chocolateyinstall", EnvironmentVariableTarget.User) ?? "";
-                    if (current_env_var != "" && Path.GetRelativePath(current_env_var, old_choco_path) == ".")
+                    if (current_env_var != "" && Path.GetRelativePath(current_env_var, OldChocoPath) == ".")
                     {
                         Logger.ImportantInfo("Migrating ChocolateyInstall environment variable to new location");
-                        Environment.SetEnvironmentVariable("chocolateyinstall", new_choco_path, EnvironmentVariableTarget.User);
+                        Environment.SetEnvironmentVariable("chocolateyinstall", NewChocoPath, EnvironmentVariableTarget.User);
                     }
 
-                    if (!Directory.Exists(new_choco_path))
+                    if (!Directory.Exists(NewChocoPath))
                     {
-                        Directory.CreateDirectory(new_choco_path);
+                        Directory.CreateDirectory(NewChocoPath);
                     }
 
-                    foreach (string old_subdir in Directory.GetDirectories(old_choco_path, "*", SearchOption.AllDirectories))
+                    foreach (string old_subdir in Directory.GetDirectories(OldChocoPath, "*", SearchOption.AllDirectories))
                     {
-                        string new_subdir = old_subdir.Replace(old_choco_path, new_choco_path);
+                        string new_subdir = old_subdir.Replace(OldChocoPath, NewChocoPath);
                         if (!Directory.Exists(new_subdir))
                         {
                             Logger.Debug("New directory: " + new_subdir);
@@ -242,9 +250,9 @@ protected override ManagerStatus LoadManager()
                         }
                     }
 
-                    foreach (string old_file in Directory.GetFiles(old_choco_path, "*", SearchOption.AllDirectories))
+                    foreach (string old_file in Directory.GetFiles(OldChocoPath, "*", SearchOption.AllDirectories))
                     {
-                        string new_file = old_file.Replace(old_choco_path, new_choco_path);
+                        string new_file = old_file.Replace(OldChocoPath, NewChocoPath);
                         if (!File.Exists(new_file))
                         {
                             Logger.Info("Copying " + old_file);
@@ -257,7 +265,7 @@ protected override ManagerStatus LoadManager()
                         }
                     }
 
-                    foreach (string old_subdir in Directory.GetDirectories(old_choco_path, "*", SearchOption.AllDirectories).Reverse())
+                    foreach (string old_subdir in Directory.GetDirectories(OldChocoPath, "*", SearchOption.AllDirectories).Reverse())
                     {
                         if (!Directory.EnumerateFiles(old_subdir).Any() && !Directory.EnumerateDirectories(old_subdir).Any())
                         {
@@ -266,15 +274,15 @@ protected override ManagerStatus LoadManager()
                         }
                     }
 
-                    if (!Directory.EnumerateFiles(old_choco_path).Any() && !Directory.EnumerateDirectories(old_choco_path).Any())
+                    if (!Directory.EnumerateFiles(OldChocoPath).Any() && !Directory.EnumerateDirectories(OldChocoPath).Any())
                     {
-                        Logger.Info("Deleting old Chocolatey directory " + old_choco_path);
-                        Directory.Delete(old_choco_path);
+                        Logger.Info("Deleting old Chocolatey directory " + OldChocoPath);
+                        Directory.Delete(OldChocoPath);
                     }
 
-                    CoreTools.CreateSymbolicLinkDir(old_choco_path, new_choco_path);
+                    CoreTools.CreateSymbolicLinkDir(OldChocoPath, NewChocoPath);
                     Settings.Set(Settings.K.ChocolateySymbolicLinkCreated, true);
-                    Logger.Info($"Symbolic link created successfully from {old_choco_path} to {new_choco_path}.");
+                    Logger.Info($"Symbolic link created successfully from {OldChocoPath} to {NewChocoPath}.");
 
                 }
                 catch (Exception e)
@@ -284,21 +292,8 @@ protected override ManagerStatus LoadManager()
                 }
             }
 
-            if (Settings.Get(Settings.K.UseSystemChocolatey))
-            {
-                status.ExecutablePath = CoreTools.Which("choco.exe").Item2;
-            }
-            else if (File.Exists(Path.Join(new_choco_path, "choco.exe")))
-            {
-                status.ExecutablePath = Path.Join(new_choco_path, "choco.exe");
-            }
-            else
-            {
-                status.ExecutablePath = Path.Join(CoreData.UniGetUIDataDirectory, "Chocolatey", "choco.exe");
-                if (!File.Exists(status.ExecutablePath)) status.ExecutablePath = "";
-            }
-
-            status.Found = File.Exists(status.ExecutablePath);
+            var (found, executable) = GetExecutableFile();
+            ManagerStatus status = new() { Found = found, ExecutablePath = executable, ExecutableCallArgs = "", };
 
             if (!status.Found)
             {
@@ -324,7 +319,7 @@ protected override ManagerStatus LoadManager()
             // If the user is running bundled chocolatey and chocolatey is not in path, add chocolatey to path
             if (!Settings.Get(Settings.K.UseSystemChocolatey)
                 && !File.Exists("C:\\ProgramData\\Chocolatey\\bin\\choco.exe"))
-                /* && Settings.Get(Settings.K.ShownWelcomeWizard)) */
+            /* && Settings.Get(Settings.K.ShownWelcomeWizard)) */
             {
                 string? path = Environment.GetEnvironmentVariable("PATH", EnvironmentVariableTarget.User);
                 if (!path?.Contains(status.ExecutablePath.Replace("\\choco.exe", "\\bin")) ?? false)