Implement #124 & add constants for exit codes

radj307 · radj307 · commit 195cf26edf03 · 2023-11-12T14:41:03.000-05:00
diff --git a/VolumeControl/Helpers/Update/ReleaseInfo.cs b/VolumeControl/Helpers/Update/ReleaseInfo.cs
@@ -18,11 +18,11 @@ public struct ReleaseInfo : IComparable<ReleaseInfo>, IEquatable<ReleaseInfo>, I
         /// Creates a new <see cref="ReleaseInfo"/> struct.
         /// </summary>
         /// <param name="responsePacket">The <see cref="GithubReleaseHttpResponse"/> packet received from the API.</param>
-        public ReleaseInfo(GithubReleaseHttpResponse responsePacket) => _packet = responsePacket;
+        public ReleaseInfo(GithubReleaseHttpResponse responsePacket) => packet = responsePacket;
         #endregion Constructor
 
         #region Fields
-        private readonly GithubReleaseHttpResponse _packet;
+        internal readonly GithubReleaseHttpResponse packet;
         #endregion Fields
 
         #region Properties
@@ -57,12 +57,12 @@ public static ReleaseInfo Latest
         /// <summary>
         /// The version number of the release represented by this struct.
         /// </summary>
-        public SemVersion Version => _version ??= (_packet.tag_name.GetSemVer() ?? new(-1));
+        public SemVersion Version => _version ??= (packet.tag_name.GetSemVer() ?? new(-1));
         private SemVersion? _version = null;
         /// <summary>
         /// The HTML URL of the release.
         /// </summary>
-        public string URL => _packet.html_url;
+        public string URL => packet.html_url;
         #endregion Properties
 
         #region Methods
diff --git a/VolumeControl/Helpers/Update/UpdateChecker.cs b/VolumeControl/Helpers/Update/UpdateChecker.cs
@@ -1,7 +1,12 @@
 ﻿using CodingSeb.Localization;
 using Semver;
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
+using System.Linq;
+using System.Net.Http;
+using System.Runtime.InteropServices;
 using System.Windows;
 using VolumeControl.Core;
 using VolumeControl.Log;
@@ -34,6 +39,10 @@ public void CheckForUpdateNow()
         {
             ReleaseInfo latest = ReleaseInfo.Latest;
 
+            // FIX WHEN DONE
+            this.ShowUpdatePrompt(latest);
+            // FIX WHEN DONE
+
             if (latest.CompareTo(this.CurrentVersion) > 0)
             {
                 FLog.Debug($"Latest version ({latest.Version}) is newer than the current version.");
@@ -47,26 +56,144 @@ public void CheckForUpdateNow()
         }
         #endregion CheckForUpdateNow
 
+        #region MakeUpdatePromptMessage
+        private string MakeUpdatePromptMessage(SemVersion latestVersion)
+        {
+            string messageCore = Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.NewVersionAvailableMessage", defaultText:
+                "A new version of Volume Control is available!\n" +
+                "Current Version:  ${CURRENT_VERSION}\n" +
+                "Latest Version:   ${LATEST_VERSION}")
+                .Replace("${CURRENT_VERSION}", this.CurrentVersion.ToString())
+                .Replace("${LATEST_VERSION}", latestVersion.ToString());
+
+            string options =
+#if RELEASE_FORINSTALLER
+                Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.NewVersionAvailable_AutoUpdate", defaultText:
+                "Click 'Yes' to install the latest release.\n" +
+                "Click 'No' if you don't want to update right now.\n" +
+                "Click 'Cancel' to disable these prompts.");
+#else
+                Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.NewVersionAvailable_OpenBrowser", defaultText:
+                "Click 'Yes' to go to the releases page.\n" +
+                "Click 'No' if you don't want to update right now.\n" +
+                "Click 'Cancel' to disable these prompts.");
+#endif
+
+            return messageCore + "\n\n" + options;
+        }
+        #endregion MakeUpdatePromptMessage
+
+        #region DownloadReleaseAsset
+        private static string? DownloadReleaseAsset(GithubAssetHttpResponse targetAsset, string outputDirectoryPath)
+        {
+            if (!Directory.Exists(outputDirectoryPath))
+            {
+                FLog.Error($"[{nameof(Update)}] Download failed; output directory \"{outputDirectoryPath}\" doesn't exist!");
+                return null;
+            }
+
+            HttpResponseMessage? response;
+            try
+            {
+                using var client = new HttpClient();
+                using var req = new HttpRequestMessage()
+                {
+                    RequestUri = new(targetAsset.url),
+                    Method = HttpMethod.Get
+                };
+                req.Headers.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/octet-stream"));
+                req.Headers.Add("User-Agent", "Volume Control");
+                response = client.Send(req);
+            }
+            catch (Exception ex)
+            {
+                FLog.Error($"[{nameof(Update)}] An exception occurred while downloading \"{targetAsset.name}\":", ex);
+                return null;
+            }
+            if (!response.IsSuccessStatusCode)
+            {
+                FLog.Error($"[{nameof(Update)}] Download request failed with status code {response.StatusCode}!");
+                return null;
+            }
+            var outputFilePath = Path.Combine(Path.GetFullPath(outputDirectoryPath), targetAsset.name);
+
+            using var stream = response.Content.ReadAsStream();
+            try
+            {
+                using var fileStream = new FileStream(outputFilePath, FileMode.Create, FileAccess.Write, FileShare.None);
+                stream.CopyTo(fileStream);
+                fileStream.Flush();
+            }
+            catch (Exception ex)
+            {
+                FLog.Error($"[{nameof(Update)}] An exception occurred while writing to file \"{outputFilePath}\":", ex);
+                return null;
+            }
+
+            return outputFilePath;
+        }
+        #endregion DownloadReleaseAsset
+
         #region ShowUpdatePrompt
         private void ShowUpdatePrompt(ReleaseInfo releaseInfo)
         {
-            FLog.Info($"Showing update prompt for new version: {releaseInfo.Version}");
+            FLog.Info($"[{nameof(Update)}] Showing update prompt for new version: {releaseInfo.Version}");
 
-            string msg = Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.NewVersionAvailableFormatMsg", "A new version of Volume Control is available!\nDo you want to go to the releases page?\nCurrent Version:  ${CURRENT_VERSION}\nLatest Version:   ${LATEST_VERSION}\n\nClick 'Yes' to go to the releases page.\nClick 'No' if you don't want to update right now.\nClick 'Cancel' to disable these prompts.");
-            msg = msg.Replace("${CURRENT_VERSION}", this.CurrentVersion.ToString());
-            msg = msg.Replace("${LATEST_VERSION}", releaseInfo.Version.ToString());
+            string msg = MakeUpdatePromptMessage(releaseInfo.Version);
 
             switch (MessageBox.Show(msg, "Update Available", MessageBoxButton.YesNoCancel, MessageBoxImage.Question, MessageBoxResult.Yes))
             {
             case MessageBoxResult.Yes: // open browser
-                FLog.Info($"User indicated they want to update to version {releaseInfo.Version}.");
-                OpenBrowser(releaseInfo.URL);
-                break;
+                {
+                    FLog.Info($"[{nameof(Update)}] User indicated they want to update to version {releaseInfo.Version}.");
+#if RELEASE_FORINSTALLER
+                    const string installerAssetNameStartsWith = "VolumeControl-Installer";
+                    var installerAsset = releaseInfo.packet.assets.FirstOrDefault(a => a.name.StartsWith(installerAssetNameStartsWith));
+                    if (string.IsNullOrEmpty(installerAsset.url))
+                    { // failed to find a release asset with the specified name
+                        FLog.Error(
+                            $"[{nameof(Update)}] Failed to download installer for \"{releaseInfo.Version}\"; couldn't find a release asset beginning with \"{installerAssetNameStartsWith}\"!",
+                            $"                   Found assets: \"{string.Join("\", \"", releaseInfo.packet.assets.Select(a => a.name))}\"");
+                        MessageBox.Show("", "Update Failed!", MessageBoxButton.OK, MessageBoxImage.Error);
+                        return;
+                    }
+                    // download the release asset
+                    if (DownloadReleaseAsset(installerAsset, KnownFolders.GetPath(KnownFolder.Downloads)) is string installerPath)
+                    { // start the installer
+                        if (ShellHelper.OpenWithDefault(installerPath))
+                        {
+                            FLog.Info($"[{nameof(Update)}] Started \"{installerPath}\"; closing the application.");
+                            Application.Current.Shutdown(Program.EXITCODE_UPDATING);
+                        }
+                        else
+                        {
+                            MessageBox.Show(
+                                Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.StartFailed.Message", "Failed to start the installer, but it was downloaded successfully.\nYour system permissions may not allow running applications from your downloads folder.\n\nYou will have to start the installer manually."),
+                                Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.StartFailed.Caption", "Failed to Start Installer"),
+                                MessageBoxButton.OK,
+                                MessageBoxImage.Error);
+                        }
+                    }
+                    else
+                    {
+                        MessageBox.Show(
+                            Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.DownloadFailed.Message", "An error occurred while downloading the installer, check the log for more information."),
+                            Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.DownloadFailed.Caption", "Download Failed"),
+                            MessageBoxButton.OK,
+                            MessageBoxImage.Error);
+                    }
+#else
+                    // open the release URL
+                    OpenBrowser(releaseInfo.URL);
+#endif
+                    break;
+                }
             case MessageBoxResult.No:
+                FLog.Info($"[{nameof(Update)}] User indicated they do not want to update.");
                 break;
             case MessageBoxResult.Cancel: // disable
                 Settings.ShowUpdatePrompt = false;
-                FLog.Info("Disabled automatic updates");
+                FLog.Info($"[{nameof(Update)}] User indicated they want to disable update prompts, and they were disabled.");
                 _ = MessageBox.Show(Loc.Tr("VolumeControl.Dialogs.UpdatePrompt.DontShowInFutureMsg", "Update prompts will not be shown in the future."));
                 break;
             }
@@ -85,7 +212,7 @@ public static void OpenBrowser(string url)
                     Verb = "open",
                     UseShellExecute = true
                 };
-                var proc = Process.Start(psi);
+                using var proc = Process.Start(psi);
                 FLog.Debug($"Successfully opened default browser with process ID {proc?.Id}");
             }
             catch (Exception ex)
@@ -97,5 +224,40 @@ public static void OpenBrowser(string url)
         #endregion OpenBrowser
 
         #endregion Methods
+
+        #region P/Invoke
+        enum KnownFolder
+        {
+            Contacts,
+            Downloads,
+            Favorites,
+            Links,
+            SavedGames,
+            SavedSearches
+        }
+        static class KnownFolders
+        {
+            private static readonly Dictionary<KnownFolder, Guid> _guids = new()
+            {
+                [KnownFolder.Contacts] = new("56784854-C6CB-462B-8169-88E350ACB882"),
+                [KnownFolder.Downloads] = new("374DE290-123F-4565-9164-39C4925E467B"),
+                [KnownFolder.Favorites] = new("1777F761-68AD-4D8A-87BD-30B759FA33DD"),
+                [KnownFolder.Links] = new("BFB9D5E0-C6A9-404C-B2B2-AE6DB6AF4968"),
+                [KnownFolder.SavedGames] = new("4C5C32FF-BB9D-43B0-B5B4-2D72E54EAAA4"),
+                [KnownFolder.SavedSearches] = new("7D1D3A04-DEBB-4115-95CF-2F29DA2920DA")
+            };
+
+            public static string GetPath(KnownFolder knownFolder)
+            {
+                return SHGetKnownFolderPath(_guids[knownFolder], 0);
+            }
+
+            [DllImport("shell32",
+                CharSet = CharSet.Unicode, ExactSpelling = true, PreserveSig = false)]
+            private static extern string SHGetKnownFolderPath(
+                [MarshalAs(UnmanagedType.LPStruct)] Guid rfid, uint dwFlags,
+                nint hToken = 0);
+        }
+        #endregion P/Invoke
     }
 }
diff --git a/VolumeControl/Localization/en.loc.json b/VolumeControl/Localization/en.loc.json
@@ -603,8 +603,30 @@
         "DontShowInFutureMsg": {
           "English (US/CA)": "Update prompts will not be shown in the future."
         },
-        "NewVersionAvailableFormatMsg": {
-          "English (US/CA)": "A new version of Volume Control is available!\nDo you want to go to the releases page?\nCurrent Version:  ${CURRENT_VERSION}\nLatest Version:   ${LATEST_VERSION}\n\nClick 'Yes' to go to the releases page.\nClick 'No' if you don't want to update right now.\nClick 'Cancel' to disable these prompts."
+        "NewVersionAvailableMessage": {
+          "English (US/CA)": "A new version of Volume Control is available!\nDo you want to go to the releases page?\nCurrent Version:  ${CURRENT_VERSION}\nLatest Version:   ${LATEST_VERSION}"
+        },
+        "NewVersionAvailableOptions_AutoUpdate": {
+          "English (US/CA)": "Click 'Yes' to install the latest release.\nClick 'No' if you don't want to update right now.\nClick 'Cancel' to disable these prompts."
+        },
+        "NewVersionAvailableOptions_OpenBrowser": {
+          "English (US/CA)": "Click 'Yes' to go to the releases page.\nClick 'No' if you don't want to update right now.\nClick 'Cancel' to disable these prompts."
+        },
+        "DownloadFailed": {
+          "Caption": {
+            "English (US/CA)": "Download Failed"
+          },
+          "Message": {
+            "English (US/CA)": "An error occurred while downloading the installer, check the log for more information."
+          }
+        },
+        "StartFailed": {
+          "Caption": {
+            "English (US/CA)": "Failed to Start Installer"
+          },
+          "Message": {
+            "English (US/CA)": "Failed to start the installer, but it was downloaded successfully.\nYour system permissions may not allow running applications from your downloads folder.\n\nYou will have to start the installer manually."
+          }
         }
       },
       "RemoveHotkey": {
diff --git a/VolumeControl/Mixer.xaml.cs b/VolumeControl/Mixer.xaml.cs
@@ -205,7 +205,7 @@ private void Handle_TargetNameBoxDoubleClick(object sender, MouseButtonEventArgs
         }
         private void Handle_MinimizeClick(object sender, RoutedEventArgs e) => this.Hide();
         private void Handle_MaximizeClick(object sender, RoutedEventArgs e) => this.WindowState = WindowState.Maximized;
-        private void Handle_CloseClick(object sender, RoutedEventArgs e) => Application.Current.Shutdown();
+        private void Handle_CloseClick(object sender, RoutedEventArgs e) => Application.Current.Shutdown(Program.EXITCODE_SUCCESS);
         private void Handle_CheckForUpdatesClick(object sender, RoutedEventArgs e) => this.VCSettings.Updater.CheckForUpdateNow();
         private void ComboBox_RemoveSelection(object sender, SelectionChangedEventArgs e)
         {
@@ -336,7 +336,7 @@ private void MultiInstanceCheckbox_CheckStateChanged(object sender, RoutedEventA
                             MessageBoxResult.OK)
                 == MessageBoxResult.OK)
             {
-                Application.Current.Shutdown(); //< this waits for the method to return; doing this first seems to prevent crashes
+                Application.Current.Shutdown(Program.EXITCODE_RESTARTING); //< this waits for the method to return; doing this first seems to prevent crashes
                 Process.Start(VCSettings.ExecutablePath, "--wait-for-mutex")?.Dispose();
             }
         }
diff --git a/VolumeControl/Program.cs b/VolumeControl/Program.cs
@@ -25,6 +25,31 @@ internal static class Program
         private const string appMutexIdentifier = "VolumeControlSingleInstance"; //< Don't change this without also changing the installer script (vcsetup.iss)
         private static Mutex appMutex = null!;
         private static Config Settings = null!;
+        /// <summary>
+        /// Occurs when the application failed to start.
+        /// </summary>
+        public const int EXITCODE_FAILED = -1;
+        /// <summary>
+        /// Occurs when the application succeeded.
+        /// </summary>
+        public const int EXITCODE_SUCCESS = 0;
+        /// <summary>
+        /// Occurs when the application closed due to a fatal error.
+        /// </summary>
+        public const int EXITCODE_ERROR = 1;
+        /// <summary>
+        /// Occurs when the application failed to acquire the mutex because another instance has it locked.
+        /// </summary>
+        public const int EXITCODE_MUTEX = 2;
+        /// <summary>
+        /// Occurs when the application is restarting itself.
+        /// </summary>
+        public const int EXITCODE_RESTARTING = 3;
+        /// <summary>
+        /// Occurs when the application launched the installer for a new version, and is shutting down to let it take over.
+        /// Only used in RELEASE_FORINSTALLER configuration.
+        /// </summary>
+        public const int EXITCODE_UPDATING = 4;
         #endregion Fields
 
         #region Methods
@@ -47,7 +72,7 @@ public static int Main(string[] args)
 #if DEBUG
                 throw; //< rethrow in DEBUG configuration
 #else
-                return 1; //< otherwise return error
+                return EXITCODE_ERROR; //< otherwise return error
 #endif
             }
         }
@@ -96,7 +121,7 @@ private static int Main_Impl(string[] args)
                     Console.Error.WriteLine($"Failed to acquire mutex \"{appMutexName}\" because another instance of Volume Control is using it!");
                     LocalizationHelper.Initialize(false, false, null);
                     MessageBox.Show(Loc.Tr($"VolumeControl.Dialogs.AnotherInstanceIsRunning.{(Settings.AllowMultipleDistinctInstances ? "MultiInstance" : "SingleInstance")}", "Another instance of Volume Control is already running!").Replace("${PATH}", Settings.Location));
-                    return 2;
+                    return EXITCODE_MUTEX;
                 }
             }
             else Console.Out.WriteLine($"Acquired mutex \"{appMutexName}\".");
@@ -164,7 +189,7 @@ private static int Main_Impl(string[] args)
 
             // create the application class
             var app = new App();
-            int rc = -1;
+            int rc = EXITCODE_FAILED;
             try
             {
                 rc = app.Run();
@@ -174,7 +199,7 @@ private static int Main_Impl(string[] args)
             {
                 // cleanup the notify icon if the program crashes (if it shuts down normally, it is correctly disposed of)
                 app.TrayIcon.Dispose(); //< do this before literally ANYTHING else
-                FLog.Fatal("App exited because of an unhandled exception:", ex);
+                FLog.Fatal($"App exited with code {rc} because of an unhandled exception:", ex);
                 FLog.Log.Flush();
                 try
                 {
diff --git a/vcsetup.iss b/vcsetup.iss
@@ -52,6 +52,7 @@ ArchitecturesInstallIn64BitMode=x64
 DefaultDirName={autopf}\VolumeControl
 DisableProgramGroupPage=yes
 ; OutputDir=publish
+;DON'T CHANGE THIS ▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼ without also changing the name in UpdateChecker.cs
 OutputBaseFilename=VolumeControl-Installer_{#AppVersion}
 SetupIconFile=VolumeControl\Resources\icons\iconSilveredInstall.ico
 Compression=lzma

Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ private void Handle_TargetNameBoxDoubleClick(object sender, MouseButtonEventArgs`
`205`	`205`	`}`
`206`	`206`	`private void Handle_MinimizeClick(object sender, RoutedEventArgs e) => this.Hide();`
`207`	`207`	`private void Handle_MaximizeClick(object sender, RoutedEventArgs e) => this.WindowState = WindowState.Maximized;`
`208`		`- private void Handle_CloseClick(object sender, RoutedEventArgs e) => Application.Current.Shutdown();`
	`208`	`+ private void Handle_CloseClick(object sender, RoutedEventArgs e) => Application.Current.Shutdown(Program.EXITCODE_SUCCESS);`
`209`	`209`	`private void Handle_CheckForUpdatesClick(object sender, RoutedEventArgs e) => this.VCSettings.Updater.CheckForUpdateNow();`
`210`	`210`	`private void ComboBox_RemoveSelection(object sender, SelectionChangedEventArgs e)`
`211`	`211`	`{`
`@@ -336,7 +336,7 @@ private void MultiInstanceCheckbox_CheckStateChanged(object sender, RoutedEventA`
`336`	`336`	`MessageBoxResult.OK)`
`337`	`337`	`== MessageBoxResult.OK)`
`338`	`338`	`{`
`339`		`- Application.Current.Shutdown(); //< this waits for the method to return; doing this first seems to prevent crashes`
	`339`	`+ Application.Current.Shutdown(Program.EXITCODE_RESTARTING); //< this waits for the method to return; doing this first seems to prevent crashes`
`340`	`340`	`Process.Start(VCSettings.ExecutablePath, "--wait-for-mutex")?.Dispose();`
`341`	`341`	`}`
`342`	`342`	`}`