Common/Installer: Warn for blocked updates, force update check when mods need it, generate support info file

Author: Kade-N

ModAPI.Common/CommonStrings.Designer.cs

@@ -167,12 +167,25 @@ If you continue to get this message, or the game is not installed from Steam, th
   <data name="SteamDownloadedButNotLaunchedTitle" xml:space="preserve">
     <value>Steam installation not completed</value>
   </data>
+  <data name="UpdateCheckDisabledNotice" xml:space="preserve">
+    <value>The Launcher Kit has been configured to skip checking for updates. You may be missing new features and bug fixes, and may be unable to use newer mods.
+
+Outdated versions of the Launcher Kit are unsupported. If you cannot use automatic updates, for example, because this computer does not have an internet connection, please periodically check https://launcherkit.sporecommunity.com for the latest updates.
+
+Would you like to automatically check for updates?</value>
+  </data>
+  <data name="UpdateCheckDisabledNoticeTitle" xml:space="preserve">
+    <value>Launcher Kit Updates Disabled</value>
+  </data>
   <data name="UpdateCheckFailed" xml:space="preserve">
     <value>The Launcher Kit could not connect to the update service. Try again in a few minutes, or check https://launcherkit.sporecommunity.com/support for help.</value>
   </data>
   <data name="UpdateCheckFailedTitle" xml:space="preserve">
     <value>Launcher Kit Update</value>
   </data>
+  <data name="UpdateUnrecognized" xml:space="preserve">
+    <value>The Launcher Kit must be updated manually. Please visit https://launcherkit.sporecommunity.com/support for more information.</value>
+  </data>
   <data name="UpdatingDllsDialog" xml:space="preserve">
     <value>ModAPI DLLs are updating to version </value>
   </data>

ModAPI.Common/CommonStrings.resx

@@ -34,7 +34,7 @@ public static class SupportInfo
         /// By default, this is "%programdata%\Spore ModAPI Launcher Kit".
         /// The path will NOT have a trailing slash.
         /// </summary>
-        public static String LauncherKitPath => Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
+        public static string LauncherKitPath => Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
 
 
 
@@ -120,7 +120,7 @@ private static DialogResult ShowMessageBox(string message, string title, bool sh
             }
 
             // Append LK info
-            message += $"\nLauncher Kit version: {LauncherKitVersionString}\nModAPI DLLs Version: {ModAPIDllsVersionString}";
+            message += $"\nLauncher Kit version: {LauncherKitVersionString}\nModAPI DLLs version: {ModAPIDllsVersionString}";
             if (showPaths)
             {
                 message += $"\nLauncher Kit path: {LauncherKitPath}";
@@ -156,5 +156,28 @@ public static DialogResult ShowError(string message, string title, bool showGame
             return ShowMessageBox(message, title, showGameInfo, showPaths, buttons, MessageBoxIcon.Error);
         }
 
+
+
+        /// <summary>
+        /// Writes a text file containing support information.
+        /// This includes the game version, game paths, Launcher Kit version, ModAPI DLLs version, and Launcher Kit path.
+        /// </summary>
+        public static void WriteSupportInfoFile(string path)
+        {
+            string[] text =
+            {
+                $"Spore version: {GameFullVersionInfoString}",
+                $"Spore path: {SporePath.GetSporebinEP1Path()}",
+                $"Spore Core data path: {SporePath.GetDataPath(SporePath.Game.Spore)}",
+                $"Spore C&C data path: {SporePath.GetDataPath(SporePath.Game.CreepyAndCute)}",
+                $"Spore GA data path: {SporePath.GetDataPath(SporePath.Game.GalacticAdventures)}",
+                $"Launcher Kit version: {LauncherKitVersionString}",
+                $"ModAPI DLLs version: {ModAPIDllsVersionString}",
+                $"Launcher Kit path: {LauncherKitPath}",
+            };
+
+            File.WriteAllLines(path, text);
+        }
+
     }
 }

ModAPI.Common/SupportInfo.cs

@@ -47,28 +47,34 @@ public static Version CurrentDllsBuild
                 if (versions.Count() > 0)
                 {
                     Version minVer = versions.Min();
-                    return new Version(minVer.Major, minVer.Minor, minVer.Build, 0);
+                    return new Version(minVer.Major, minVer.Minor, minVer.Build, 0); // revision must be 0 for update checking purposes, as we use revision to indicate whether the DLL is for disc/download/combined versions
                 }
                 else
                     return new Version(999, 999, 999, 999);
             }
         }
+        public static bool IsUpdateCheckDisabled => File.Exists(UpdaterBlockPath);
 
         public static void CheckForUpdates()
         {
+            // Create appdata folder if it doesn't exist
+            Directory.CreateDirectory(AppDataPath);
+
+            // Write support info file to appdata folder
+            SupportInfo.WriteSupportInfoFile(Path.Combine(AppDataPath, "support.info"));
+
+            // Make sure game is not running before running any Launcher Kit apps
             if ((Process.GetProcessesByName("SporeApp").Length > 0) || (Process.GetProcessesByName("SporeApp_ModAPIFix").Length > 0))
             {
                 SupportInfo.ShowWarning(CommonStrings.GameAlreadyRunning, CommonStrings.GameAlreadyRunningTitle, true, false);
                 Process.GetCurrentProcess().Kill();
             }
 
-            if (!Directory.Exists(AppDataPath))
-                Directory.CreateDirectory(AppDataPath);
-
-            File.WriteAllText(Path.Combine(AppDataPath, "path.info"), Directory.GetParent(Assembly.GetEntryAssembly().Location).ToString());
-
+            // Delete old updater exe if present
             if (File.Exists(UpdaterDestPath))
+            {
                 File.Delete(UpdaterDestPath);
+            }
 
             if (File.Exists(LastUpdateCheckTimePath))
             {
@@ -79,20 +85,35 @@ public static void CheckForUpdates()
                                                                         LastUpdateDateTimeFormat,
                                                                         CultureInfo.InvariantCulture);
 
+                    // If it's been less than an hour since last update check, don't check again
                     if ((DateTime.Now - lastUpdateCheckDateTime).TotalHours < 1)
                     {
                         return;
                     }
+
+                    // If update check is disabled, and it's been more than 30 days since last update check, prompt user to check for updates
+                    if (IsUpdateCheckDisabled && (DateTime.Now - lastUpdateCheckDateTime).TotalDays >= 30)
+                    {
+                        PromptUserUnblockUpdates();
+                    }
                 }
                 catch (Exception)
                 {
-                    File.Delete(LastUpdateCheckTimePath);
+                    ResetLastUpdateCheckTime();
                 }
             }
+            else if (IsUpdateCheckDisabled)
+            {
+                // If update check is disabled, and this is a new install or we force checked for updates, prompt user to check for updates
+                PromptUserUnblockUpdates();
+            }
 
-            if (File.Exists(UpdaterBlockPath))
+            // Record current time as last update check time
+            File.WriteAllText(LastUpdateCheckTimePath, DateTime.Now.ToString(LastUpdateDateTimeFormat));
+
+            // Don't check for updates when block file exists
+            if (IsUpdateCheckDisabled)
             {
-                // don't check for updates when block file exists
                 return;
             }
 
@@ -254,8 +275,6 @@ public static void CheckForUpdates()
                         dialog.ShowDialog();
                     }
                 }
-
-                File.WriteAllText(LastUpdateCheckTimePath, DateTime.Now.ToString(LastUpdateDateTimeFormat));
             }
             catch (Exception ex)
             {
@@ -288,7 +307,31 @@ static void ShowUpdateCheckFailedMessage(List<Exception> exceptions)
 
         static void ShowUnrecognizedUpdateInfoVersionMessage()
         {
-            SupportInfo.ShowInfo("This update to the Spore ModAPI Launcher Kit must be downloaded manually. Please visit https://launcherkit.sporecommunity.com/support for more information.", CommonStrings.UpdateCheckFailedTitle, false, true);
+            SupportInfo.ShowInfo(CommonStrings.UpdateUnrecognized, CommonStrings.UpdateCheckFailedTitle, false, true);
+        }
+
+        /// <summary>
+        /// Forces the Launcher Kit to check for updates the next time it is run, skipping the one hour timeout.
+        /// If updates are blocked, this will also prompt the user to unblock updates on next launch.
+        /// </summary>
+        public static void ResetLastUpdateCheckTime()
+        {
+            File.Delete(LastUpdateCheckTimePath);
         }
+
+        /// <summary>
+        /// Warns the user that update checks are disabled, and prompts them to re-enable.
+        /// Returns Yes or No depending on whether the user wants to re-enable update checks. If Yes, the update block file is removed.
+        /// </summary>
+        static DialogResult PromptUserUnblockUpdates()
+        {
+            var result = SupportInfo.ShowInfo(CommonStrings.UpdateCheckDisabledNotice, CommonStrings.UpdateCheckDisabledNoticeTitle, false, false, MessageBoxButtons.YesNo);
+            if (result == DialogResult.Yes)
+            {
+                File.Delete(UpdaterBlockPath);
+            }
+            return result;
+        }
+
     }
 }

ModAPI.Common/Update/UpdateManager.cs

@@ -400,6 +400,7 @@ static ResultType TryExecuteInstaller(string inputFile, string modName)
                     if (modCoreDllsVersion != null && modCoreDllsVersion > UpdateManager.CurrentDllsBuild)
                     {
                         SupportInfo.ShowWarning(Strings.OutdatedDllVersion.Replace("$MODNAME$", modName).Replace("$REQUIREDVERSION$", modCoreDllsVersion.ToString()), Strings.OutdatedDllVersionTitle, false, false);
+                        UpdateManager.ResetLastUpdateCheckTime();
                         return ResultType.ModNotInstalled;
                     }
                     // If the version is not specified, continue installing (the value is optional because not all mods use the ModAPI SDK)

Spore ModAPI Easy Installer/EasyInstaller.cs

@@ -157,12 +157,12 @@
     <value>Installation completed</value>
   </data>
   <data name="OutdatedDllVersion" xml:space="preserve">
-    <value> cannot be installed, because it requires a newer version of the ModAPI DLLs. Please restart the launcher and allow it to update.
+    <value>"$MODNAME$" cannot be installed, because it requires a newer version of the ModAPI DLLs. Please restart the launcher and allow it to update.
 
 Required ModAPI DLLs version: $REQUIREDVERSION$ or higher</value>
   </data>
   <data name="InvalidDllVersion" xml:space="preserve">
-    <value> cannot be installed, because it specifies an invalid version of the ModAPI DLLs. Please ask the mod developer for help.</value>
+    <value>"$MODNAME$" cannot be installed, because it specifies an invalid version of the ModAPI DLLs. Please ask the mod developer for help.</value>
   </data>
   <data name="UnauthorizedAccess" xml:space="preserve">
     <value>The Easy Installer does not currently have permission to install or change mods. You may need to right-click the Easy Installer and "Run as Administrator".</value>

Spore ModAPI Easy Installer/Strings.Designer.cs

@@ -198,7 +198,10 @@ private void PrepareInstaller()
                         if ((Document.SelectSingleNode("/mod").Attributes["dllsBuild"] != null) && (Version.TryParse(Document.SelectSingleNode("/mod").Attributes["dllsBuild"].Value + ".0", out Version minFeaturesLevel)))
                         {
                             if (minFeaturesLevel > UpdateManager.CurrentDllsBuild)
+                            {
+                                UpdateManager.ResetLastUpdateCheckTime();
                                 CyclePage(0, 2);
+                            }
                         }
                         else
                             throw new Exception("This Mod has not specified a valid minimum features level. Please inform the mod's developer of this.");
@@ -283,6 +286,7 @@ private void PrepareInstaller()
                 }
                 else
                 {
+                    UpdateManager.ResetLastUpdateCheckTime();
                     CyclePage(0, 2);
                 }
             }