[WIP] Partially working RunShortcut command

The RunShortcut commandline option mostly works
but it fails to cleanly execute thanks to a partially broken
Program.ApplyProfile. The ApplyProfile exception logic
is not working properly and that is causing an exception
in Program.RunShortcut. Just needs some improved
ApplyProfile logic to detect when it does actually
(correctly) fail.
This commit is contained in:
Terry MacDonald 2020-10-11 21:12:52 +13:00
parent 7c34a02213
commit 12e3229f9d
5 changed files with 63 additions and 37 deletions

View File

@ -44,7 +44,7 @@ namespace HeliosPlus.Shared
// ReSharper disable once MethodTooLong // ReSharper disable once MethodTooLong
// ReSharper disable once TooManyArguments // ReSharper disable once TooManyArguments
public static void Open( public static void Open(
HeliosStartupAction action = HeliosStartupAction.None, HeliosStartupAction action = HeliosStartupAction.StartUpNormally,
ProfileItem profile = null, ProfileItem profile = null,
string programAddress = null, string programAddress = null,
bool asAdmin = false) bool asAdmin = false)
@ -93,7 +93,7 @@ namespace HeliosPlus.Shared
} }
public static void OpenSteamGame( public static void OpenSteamGame(
HeliosStartupAction action = HeliosStartupAction.None, HeliosStartupAction action = HeliosStartupAction.StartUpNormally,
ProfileItem profile = null, ProfileItem profile = null,
uint steamAppId = 0) uint steamAppId = 0)
{ {

View File

@ -2,12 +2,7 @@
{ {
public enum HeliosStartupAction public enum HeliosStartupAction
{ {
None, RunShortcut,
StartUpNormally
SwitchProfile,
CreateShortcut,
EditProfile
} }
} }

View File

@ -22,12 +22,6 @@ using System.Drawing;
using System.Diagnostics.Contracts; using System.Diagnostics.Contracts;
namespace HeliosPlus { namespace HeliosPlus {
public enum SupportedProgramMode
{
RunShortcut,
EditProfile,
StartUpNormally
}
public enum SupportedGameLibrary public enum SupportedGameLibrary
{ {
@ -86,15 +80,15 @@ namespace HeliosPlus {
}); });
// This is the RunShortcut command // This is the RunShortcut command
app.Command(SupportedProgramMode.RunShortcut.ToString(), (switchProfileCmd) => app.Command(HeliosStartupAction.RunShortcut.ToString(), (runShortcutCmd) =>
{ {
var argumentShortcut = switchProfileCmd.Argument("\"SHORTCUT_UUID\"", "(required) The UUID of the shortcut to run from those stored in the shortcut library.").IsRequired(); var argumentShortcut = runShortcutCmd.Argument("\"SHORTCUT_UUID\"", "(required) The UUID of the shortcut to run from those stored in the shortcut library.").IsRequired();
argumentShortcut.Validators.Add(new ShortcutMustExistValidator()); argumentShortcut.Validators.Add(new ShortcutMustExistValidator());
//description and help text of the command. //description and help text of the command.
switchProfileCmd.Description = "Use this command to run favourite game or application with a display profile of your choosing."; runShortcutCmd.Description = "Use this command to run favourite game or application with a display profile of your choosing.";
switchProfileCmd.OnExecute(() => runShortcutCmd.OnExecute(() =>
{ {
// //
RunShortcut(argumentShortcut.Value); RunShortcut(argumentShortcut.Value);
@ -118,11 +112,12 @@ namespace HeliosPlus {
} }
catch (CommandParsingException ex) catch (CommandParsingException ex)
{ {
Console.WriteLine($"Program/Main commandParsingException: {ex.Message}: {ex.StackTrace} - {ex.InnerException}"); //Console.WriteLine($"Program/Main commandParsingException: {ex.Message}: {ex.StackTrace} - {ex.InnerException}");
// You'll always want to catch this exception, otherwise it will generate a messy and confusing error for the end user. // You'll always want to catch this exception, otherwise it will generate a messy and confusing error for the end user.
// the message will usually be something like: // the message will usually be something like:
// "Unrecognized command or argument '<invalid-command>'" // "Unrecognized command or argument '<invalid-command>'"
Console.WriteLine(ex.Message); //Console.WriteLine(ex.Message);
Console.WriteLine("Didn't recognise the supplied commandline options: {0}", ex.Message);
} }
catch (Exception ex) catch (Exception ex)
{ {

View File

@ -603,7 +603,7 @@ namespace HeliosPlus
var shortcutArgs = new List<string> var shortcutArgs = new List<string>
{ {
// Add the SwitchProfile command as the first argument to start to switch to another profile // Add the SwitchProfile command as the first argument to start to switch to another profile
$"{HeliosStartupAction.SwitchProfile}", $"{HeliosStartupAction.RunShortcut}",
$"\"{UUID}\"" $"\"{UUID}\""
}; };

View File

@ -477,24 +477,49 @@ namespace HeliosPlus
} }
// Remember the profile we are on now // Remember the profile we are on now
bool needToChangeProfiles = false;
ProfileItem rollbackProfile = ProfileRepository.CurrentProfile; ProfileItem rollbackProfile = ProfileRepository.CurrentProfile;
if (!rollbackProfile.Equals(shortcutToUse.ProfileToUse))
needToChangeProfiles = true;
// Tell the IPC Service we are busy right now, and keep the previous status for later // Tell the IPC Service we are busy right now, and keep the previous status for later
InstanceStatus rollbackInstanceStatus = IPCService.GetInstance().Status; InstanceStatus rollbackInstanceStatus = IPCService.GetInstance().Status;
IPCService.GetInstance().Status = InstanceStatus.Busy; IPCService.GetInstance().Status = InstanceStatus.Busy;
// Apply the Profile! // Only change profiles if we have to
//if (!ProfileRepository.ApplyProfile(shortcutToUse.ProfileToUse)) if (needToChangeProfiles)
if (!Program.ApplyProfile(shortcutToUse.ProfileToUse))
{ {
throw new Exception(Language.Cannot_change_active_profile); // Apply the Profile!
//if (!ProfileRepository.ApplyProfile(shortcutToUse.ProfileToUse))
if (!Program.ApplyProfile(shortcutToUse.ProfileToUse))
{
throw new Exception(Language.Cannot_change_active_profile);
}
} }
// Set the IP Service status back to what it was // Set the IP Service status back to what it was
IPCService.GetInstance().Status = rollbackInstanceStatus; IPCService.GetInstance().Status = rollbackInstanceStatus;
// Now run the pre-start applications // Now run the pre-start applications
// TODO: Add the prestart applications List<Process> startProgramsToStop = new List<Process>();
if (shortcutToUse.StartPrograms is List<StartProgram> && shortcutToUse.StartPrograms.Count > 0)
{
foreach (StartProgram myStartProgram in shortcutToUse.StartPrograms
.Where(program => program.Enabled == true && program.CloseOnFinish == true)
.OrderBy(program => program.Priority))
{
// Start the executable
Process process = null;
if (myStartProgram.ExecutableArgumentsRequired)
process = System.Diagnostics.Process.Start(myStartProgram.Executable, myStartProgram.Arguments);
else
process = System.Diagnostics.Process.Start(myStartProgram.Executable);
// Record t
startProgramsToStop.Add(process);
}
}
// Now start the main game, and wait if we have to // Now start the main game, and wait if we have to
if (shortcutToUse.Category.Equals(ShortcutCategory.Application)) if (shortcutToUse.Category.Equals(ShortcutCategory.Application))
@ -507,13 +532,13 @@ namespace HeliosPlus
process = System.Diagnostics.Process.Start(shortcutToUse.ExecutableNameAndPath); process = System.Diagnostics.Process.Start(shortcutToUse.ExecutableNameAndPath);
// Create a list of processes to monitor // Create a list of processes to monitor
Process[] processesToMonitor = Array.Empty<Process>(); List<Process> processesToMonitor = new List<Process>();
// Work out if we are monitoring another process other than the main executable // Work out if we are monitoring another process other than the main executable
if (shortcutToUse.ProcessNameToMonitorUsesExecutable) if (shortcutToUse.ProcessNameToMonitorUsesExecutable)
{ {
// If we are monitoring the same executable we started, then lets do that // If we are monitoring the same executable we started, then lets do that
processesToMonitor = new[] { process }; processesToMonitor.Add(process);
} }
else else
{ {
@ -522,10 +547,10 @@ namespace HeliosPlus
while (ticks < shortcutToUse.ExecutableTimeout * 1000) while (ticks < shortcutToUse.ExecutableTimeout * 1000)
{ {
// Look for the processes with the ProcessName we want (which in Windows is the filename without the extension) // Look for the processes with the ProcessName we want (which in Windows is the filename without the extension)
processesToMonitor = System.Diagnostics.Process.GetProcessesByName(Path.GetFileNameWithoutExtension(shortcutToUse.DifferentExecutableToMonitor)); processesToMonitor = System.Diagnostics.Process.GetProcessesByName(Path.GetFileNameWithoutExtension(shortcutToUse.DifferentExecutableToMonitor)).ToList();
// TODO: Fix this logic error that will only ever wait for the first process.... // TODO: Fix this logic error that will only ever wait for the first process....
if (processesToMonitor.Length > 0) if (processesToMonitor.Count > 0)
{ {
break; break;
} }
@ -534,10 +559,10 @@ namespace HeliosPlus
ticks += 300; ticks += 300;
} }
// If none started up before the timeout, then ignore the // If none started up before the timeout, then ignore them
if (processesToMonitor.Length == 0) if (processesToMonitor.Count == 0)
{ {
processesToMonitor = new[] { process }; processesToMonitor.Add(process);
} }
} }
@ -692,8 +717,19 @@ namespace HeliosPlus
} }
// Change back to the original profile if it is different // Stop the pre-started startPrograms that we'd started earlier
if (!ProfileRepository.IsActiveProfile(rollbackProfile)) if (startProgramsToStop.Count > 0)
{
// Stop the programs in the reverse order we started them
foreach (Process processToStop in startProgramsToStop.Reverse<Process>())
{
// Stop the program
processToStop.Close();
}
}
// Change back to the original profile only if it is different
if (needToChangeProfiles)
{ {
//if (!ProfileRepository.ApplyProfile(rollbackProfile)) //if (!ProfileRepository.ApplyProfile(rollbackProfile))
if (!Program.ApplyProfile(rollbackProfile)) if (!Program.ApplyProfile(rollbackProfile))