RTT Process Control opt in implemented

now does ready check
now does status reports

Author: derammo

HeliosFalcon/Interfaces/FalconInterface.cs

@@ -657,7 +657,10 @@ public override IEnumerable<StatusReportItem> PerformReadyCheck()
 
             if (Rtt != null)
             {
-                yield return Rtt.OnReadyCheck();
+                foreach (StatusReportItem statusReportItem in Rtt.OnReadyCheck())
+                {
+                    yield return statusReportItem;
+                }
             }
         }
 

HeliosFalcon/Interfaces/RTT/ConfigGenerator.cs

@@ -1,4 +1,4 @@
-// Copyright 2021 Ammo Goettsch
+// Copyright 2021 Helios Contributors
 // 
 // HeliosFalcon is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -48,11 +48,11 @@
 - on status report
     - if disabled due to no magic cookie on load, show special status asking to enable for consent
     - show configuration that will be generated
-    - warn if profile wants to start/stop RTT but global policy disallows it
+    - error if profile wants to start/stop RTT but global policy disallows it
 - on ready check
     - make sure falcon interface is configured 
     - make sure file either does not exist or is helios owned
-    - make sure process control we plan to use is actually permitted (warn or error if start/stop is configurable)
+    - error if profile wants to start/stop RTT but global policy disallows it
 - on profile start
     - refuse to overwrite non-Helios file
     - launch RTT process 
@@ -218,7 +218,7 @@ internal IEnumerable<StatusReportItem> OnStatusReport(IEnumerable<ShadowVisual>
                     Status =
                         "RTT feature has been disabled, because an existing RTT configuration would be overwritten by this profile",
                     Recommendation =
-                        "Enable the RTT feature again to back up the existing file and let Helios to generate RTT displays"
+                        "Enable the RTT feature again to back up the existing file and let Helios generate RTT displays"
                 }.AsReport();
             }
 
@@ -227,7 +227,17 @@ internal IEnumerable<StatusReportItem> OnStatusReport(IEnumerable<ShadowVisual>
                 return new StatusReportItem[0];
             }
 
-            // REVISIT: for now, we show the whole generated file
+            // gather status from child objects, if any
+            IEnumerable<StatusReportItem> processControlReport =
+                ProcessControl?.OnStatusReport() ?? new StatusReportItem[0];
+
+            return processControlReport
+                .Concat(ReportLInes());
+        }
+
+        private IEnumerable<StatusReportItem> ReportLInes()
+        {
+            // we show the whole generated file, so it will be in the interface status report
             return _lines
                 .Select(line => new StatusReportItem
                 {
@@ -309,21 +319,49 @@ internal void OnInteractivelyEnabled(CheckBox source)
         }
 
         /// <summary>
-        /// create a single ready check item for our parent's ReadyCheck
+        /// create a ready check items for our parent's ReadyCheck
         /// </summary>
         /// <returns></returns>
-        internal StatusReportItem OnReadyCheck()
+        internal IEnumerable<StatusReportItem> OnReadyCheck()
         {
+            if (DisabledUntilConsent)
+            {
+                yield return new StatusReportItem
+                {
+                    Severity = StatusReportItem.SeverityCode.Error,
+                    Status =
+                        "RTT feature has been disabled, because an existing RTT configuration would be overwritten by this profile",
+                    Link = StatusReportItem.ProfileEditor,
+                    Recommendation =
+                        "Enable the RTT feature again to back up the existing file and let Helios generate RTT displays"
+                };
+                yield break;
+            }
+
             if (!Enabled)
             {
-                return new StatusReportItem
+                yield return new StatusReportItem
                 {
                     Status = "RTT client configuration feature is not enabled",
                     Flags = StatusReportItem.StatusFlags.ConfigurationUpToDate | StatusReportItem.StatusFlags.Verbose
 
                 };
+                yield break;
+            }
+
+            yield return CheckConfigFile();
+
+            if (ProcessControl != null)
+            {
+                foreach (StatusReportItem statusReportItem in ProcessControl.OnReadyCheck())
+                {
+                    yield return statusReportItem;
+                }
             }
+        }
 
+        private StatusReportItem CheckConfigFile()
+        {
             if (string.IsNullOrEmpty(Parent.FalconPath))
             {
                 return new StatusReportItem
@@ -388,8 +426,6 @@ internal StatusReportItem OnReadyCheck()
 
         internal void OnProfileStart()
         {
-            StartedProcess = false;
-
             // check for Helios ownership of the RTT file and if it is ours, write the RTT configuration for the current profile,
             // which may not be the most recent one we configured in Profile Editor
             if (!UpdateRttConfigurationFile())
@@ -398,27 +434,12 @@ internal void OnProfileStart()
                 return;
             }
 
-            if (ProcessControl?.StartRtt ?? false)
-            {
-                // launch RTT
-                string selectedClient = ProcessControl.SelectClient(Networked);
-                StartedProcess =
-                    ProcessControl.StartRTTClient(Path.Combine(Parent.FalconPath, "Tools", "RTTRemote", selectedClient));
-                Logger.Info($"launching RTT client: {selectedClient}");
-            }
+            ProcessControl?.OnProfileStart(Parent, Networked);
         }
 
         internal void OnProfileStop()
         {
-            if (!StartedProcess)
-            {
-                return;
-            }
-
-            if (ProcessControl?.StopRtt ?? false)
-            {
-                ProcessControl.KillRTTCllient(Path.GetFileNameWithoutExtension(ProcessControl.SelectClient(Networked)));
-            }
+            ProcessControl?.OnProfileStop(Parent, Networked);
         }
 
         /// <summary>
@@ -816,12 +837,6 @@ public ICommand EnabledCommand
         [XmlIgnore] 
         public IRttGeneratorHost Parent { get; internal set; }
 
-        /// <summary>
-        /// if true, we started RTT process on this run
-        /// </summary>
-        [XmlIgnore]
-        public bool StartedProcess { get; private set; }
-
         #endregion
 
         /// <summary>

HeliosFalcon/Interfaces/RTT/InterfaceEditor.xaml

@@ -246,7 +246,6 @@
                        Grid.ColumnSpan="2" />
                 <CheckBox Grid.Column="2"
                           VerticalAlignment="Center"
-                          IsEnabled="{Binding ProcessControl.Enabled}"
                           IsChecked="{Binding ProcessControl.StartRtt}"
                           Margin="0,60,0,85" />
                 <TextBlock Text="Start the RTT Cllient automatically when the profile starts"
@@ -265,7 +264,6 @@
                        Grid.ColumnSpan="2" />
                 <CheckBox Grid.Column="2"
                           VerticalAlignment="Center"
-                          IsEnabled="{Binding ProcessControl.Enabled}"
                           IsChecked="{Binding ProcessControl.StopRtt}"
                           Margin="0,86,0,59" />
                 <TextBlock Text="Stop the RTT Cllient automatically when the profile stops"

HeliosFalcon/Interfaces/RTT/ProcessControl.cs

@@ -1,5 +1,5 @@
-// Copyright 2021 Ammo Goettsch
-// 
+// Copyright 2021 Helios Contributors
+//
 // HeliosFalcon is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
@@ -15,6 +15,7 @@
 // 
 
 using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.Diagnostics;
 using System.IO;
@@ -48,7 +49,76 @@ public class ProcessControl : NotificationObject
         /// </summary>
         private bool _enabled = ConfigManager.SettingsManager.LoadSetting(CONFIGURATION_GROUP, CONFIGURATION_SETTING_ENABLED, false);
 
-        public bool StartRTTClient(string executablePath)
+        internal IEnumerable<StatusReportItem> OnStatusReport()
+        {
+            return CheckCommonItems();
+        }
+
+        internal IEnumerable<StatusReportItem> OnReadyCheck()
+        {
+            return CheckCommonItems();
+        }
+
+        internal void OnProfileStart(IRttGeneratorHost parent, bool networked)
+        {
+            StartedProcess = false;
+
+            if (!StartRtt)
+            {
+                return;
+            }
+
+            if (!Enabled)
+            {
+                Logger.Warn("Profile requested starting of RTT Client process, but this operation is not permitted on this computer");
+                return;
+            }
+
+            // launch RTT
+            string selectedClient = SelectClient(networked);
+            Logger.Info($"launching RTT client: {selectedClient}");
+            StartedProcess =
+                StartRTTClient(Path.Combine(parent.FalconPath, "Tools", "RTTRemote", selectedClient));
+        }
+
+        internal void OnProfileStop(IRttGeneratorHost _, bool networked)
+        {
+            if (!StartedProcess)
+            {
+                return;
+            }
+
+            if (!StopRtt)
+            {
+                return;
+            }
+
+            if (!Enabled)
+            {
+                Logger.Warn("Profile requested stopping of RTT Client process, but this operation is not permitted on this computer");
+                return;
+            }
+
+            KillRTTCllient(Path.GetFileNameWithoutExtension(SelectClient(networked)));
+        }
+
+        private IEnumerable<StatusReportItem> CheckCommonItems()
+        {
+            if ((StartRtt || StopRtt) && !Enabled)
+            {
+                // nothing will happen, unless the user opts in
+                yield return new StatusReportItem
+                {
+                    Status =
+                        "The profile requests starting and/or stopping of the RTT Client process, but you have not allowed Helios to do so",
+                    Severity = StatusReportItem.SeverityCode.Error,
+                    Link = StatusReportItem.ProfileEditor,
+                    Recommendation = "Allow the RTT Process Control feature in the Falcon Interface"
+                };
+            }
+        }
+
+        private bool StartRTTClient(string executablePath)
         {
             if (!File.Exists(executablePath))
             {
@@ -65,7 +135,7 @@ public bool StartRTTClient(string executablePath)
             return true;
         }
 
-        public void KillRTTCllient(string processName)
+        private void KillRTTCllient(string processName)
         {
             try
             {
@@ -88,7 +158,7 @@ public void KillRTTCllient(string processName)
         /// </summary>
         /// <param name="networked"></param>
         /// <returns>selected</returns>
-        internal string SelectClient(bool networked)
+        private string SelectClient(bool networked)
         {
             string selected;
             if (Environment.Is64BitProcess)
@@ -168,6 +238,12 @@ public bool Enabled
             }
         }
 
+        /// <summary>
+        /// if true, we started RTT process on this run
+        /// </summary>
+        [XmlIgnore]
+        public bool StartedProcess { get; private set; }
+
         #endregion
     }
 }