Automatic merge of T1.5.1-1004-g6fd841761e and 26 pull requests

- Pull request #799 at dfc715e: Consolidated wind simulation
- Pull request #839 at d00beb9: First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters
- Pull request #876 at f92de76: docs: add source for documents previously on website to source Documentation folder
- Pull request #882 at 8f695a4: Blueprint/train car operations UI window
- Pull request #885 at e267870: feat: Add notifications to Menu
- Pull request #891 at 9a1d6b2: Auto save
- Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH
- Pull request #896 at 5866028: First implementation of https://blueprints.launchpad.net/or/+spec/specific-sounds-for-ai-trains
- Pull request #900 at c27f32d: DMI updates
- Pull request #903 at 3e390b8: Downloading route content (Github, zip)
- Pull request #912 at 359cfee: New Triple Valve Features Vol. 2
- Pull request #922 at a3bc9e7: Autopilot for timetable mode
- Pull request #946 at 91a03af: Advanced track sounds
- Pull request #949 at da7663b: Oil Burning Locomotive
- Pull request #952 at 8347095: Investigation - Pulsing graphics
- Pull request #953 at a519452: Fix Lights Crash on Corrupt Shapes
- Pull request #954 at 84c2f4b: Add Support for Multiple Track Profiles
- Pull request #956 at 406cba6: Map settings saved
- Pull request #959 at 2452cb0: Fix TrackViewer crash on big zoom value
- Pull request #960 at c8e2a28: Fix draw state name in scripts
- Pull request #962 at 46d0472: Fix pantographs on unpowered cars
- Pull request #963 at 2d5a67d: Fix dynamic brake force indicator
- Pull request #964 at b11c894: fix: Warning CA1417: Do not use the 'OutAttribute' for string parameter
- Pull request #965 at 7554f02: style: Renormalize line endings
- Pull request #966 at 6353e03: fix: Warning CS0618: 'string.Copy(string)' is obsolete
- Pull request #967 at a799e20: Fix AI Lights After Reversing Points

Author: openrails-bot

Source/Documentation/Notifications.docx

@@ -20,15 +20,20 @@
 using System.IO;
 using System.Linq;
 using System.Net;
+using System.Security.Policy;
 using System.Text;
 using Newtonsoft.Json;
 using ORTS.Common;
 using ORTS.Settings;
 using ORTS.Updater;
 using SharpDX;
+using static System.Windows.Forms.VisualStyles.VisualStyleElement;
 using static ORTS.Common.SystemInfo;
 using static ORTS.NotificationPage;
 
+//TODO Add caching of criteria
+//TODO Add "includeIf" for individual notifications
+
 namespace ORTS
 {
     class NotificationManager
@@ -46,9 +51,9 @@ class NotificationManager
         private Exception Error;
         private Dictionary<string, string> ParameterDictionary;
 
-        private MainForm MainForm; // Needed so we can add controls to the NotificationPage
-        private UpdateManager UpdateManager;
-        private UserSettings Settings;
+        private readonly MainForm MainForm; // Needed so we can add controls to the NotificationPage
+        private readonly UpdateManager UpdateManager;
+        private readonly UserSettings Settings;
 
         public NotificationManager(MainForm mainForm, UpdateManager updateManager, UserSettings settings) 
         { 
@@ -64,7 +69,6 @@ public void CheckNotifications()
             {
                 Error = null;
                 Notifications = GetNotifications();
-                DropUnusedUpdateNotifications();
                 ParameterDictionary = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
 
                 // To support testing, add any overriding values to the ValueDictionary
@@ -84,7 +88,7 @@ public void CheckNotifications()
         }
 
         static bool Log = false;
-        static string LogFile = "notifications_trial_log.txt";
+        const string LogFile = "notifications_trial_log.txt";
 
         public Notifications GetNotifications()
         {
@@ -128,7 +132,7 @@ private string GetRemoteJson()
             // Helpful to supply server with data for its log file.
             client.Headers[HttpRequestHeader.UserAgent] = $"{System.Windows.Forms.Application.ProductName}/{VersionInfo.VersionOrBuild}";
 
-            return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications/menu.json"));
+            return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications2/menu.json"));
         }
 
         public void PopulatePageList()
@@ -144,7 +148,7 @@ public void PopulatePageList()
         /// Ultimately there will be a list of notifications downloaded from https://static.openrails.org/api/notifications/menu.json .
         /// Until then, there is a single notification announcing either that a new update is available or the installation is up to date.
         /// </summary>
-        void SetUpdateNotificationPage()
+        private void SetUpdateNotificationPage()
         {
             MainForm.UpdateNotificationPageAlert();
             PageList.Clear();
@@ -181,93 +185,60 @@ void SetUpdateNotificationPage()
             var skipPage = false;
             new NTitleControl(page, Index + 1, list.Count, n.Date, n.Title).Add();
 
-            // Check constraints for the MetList.
-            var failingCheck = (n.Met.ItemList?.Count > 0 && n.Met.CheckIdList?.Count > 0) 
-                ? CheckConstraints(n) 
-                : null;
+            // Check constraints for each item
+            foreach(var item in n.ItemList)
+            {
+                if (AreChecksMet(item)) AddItemToPage(page, item);
+            }
+            if (skipPage == false) PageList.Add(page);
+        }
 
-            // If any check fails then its UnmetList is added to the page, otherwise the MetList is added.
-            n.PrefixItemList?.ForEach(item => AddItemToPage(page, item));
-            if (failingCheck == null)
+        #region Process Criteria
+        private bool AreChecksMet(Item item)
+        {
+            if (item.IncludeIf != null || item.IncludeIfNot != null)
             {
-                n.Met.ItemList?.ForEach(item => AddItemToPage(page, item));
+                AppendToLog($"Label: {item.Label}");
             }
-            else
+                if (item.IncludeIf != null)
             {
-                if (failingCheck.UnmetItemList == null) // Omit this section to skip the notification entirely.
+                foreach (var checkName in item.IncludeIf)
                 {
-                    // Don't skip if there is only one notification.
-                    if (list.Count > 1) skipPage = true;
+                    // Include if A=true AND B=true AND ...
+                    if (IsCheckMet(checkName) == false) return false;
                 }
-                else
+            }
+            if (item.IncludeIfNot != null)
+            {
+                foreach (var checkName in item.IncludeIfNot)
                 {
-                    failingCheck.UnmetItemList?.ForEach(item => AddItemToPage(page, item));
+                    // Include if C=false AND D=false AND ...
+                    if (IsCheckMet(checkName) == true) return false;
                 }
             }
-            n.SuffixItemList?.ForEach(item => AddItemToPage(page, item));
-            if (skipPage == false) PageList.Add(page);
+
+            return true;
         }
 
-        /// <summary>
-        /// CheckConstraints() checks the constraints in sequence, but all parts are optional.
-        /// If all the constraints in any Includes are met, then the whole check is met.
-        /// If all the constraints in any Excludes are met, then the whole check is not met.
-        /// Returns null if the whole check is met else returns the check that failed.
-        /// </summary>
-        /// <param name="n"></param>
-        private Check CheckConstraints(Notification n)
+        private bool IsCheckMet(string checkname)
         {
-            Check failingCheck = null;
-            foreach (var nc in n.Met.CheckIdList) // CheckIdList is optional
+            foreach (var check in Notifications.CheckList)
             {
-                LogChecks(nc);
-
-                // Find the matching check
-                var check = Notifications.CheckList.Where(c => c.Id == nc.Id).FirstOrDefault();
-                if (check != null && check.AnyOfList.Count() > 0)
+                if (check.Id == checkname)
                 {
-                    foreach(var anyOf in check.AnyOfList)
-                    {
-                        if (anyOf is Excludes)
-                        {
-                            if (CheckAllMatch(anyOf.AllOfList) == true) return check; // immediate fail so quit
-                        }
-                        if (anyOf is Includes)
-                        {
-                            if (CheckAllMatch(anyOf.AllOfList) == false) failingCheck = check; // fail but continue testing other Includes
-                        }
-                    }
+                    if (CheckAnyMatch(check.AnyOfList)) return true;
                 }
             }
-            return failingCheck;
+            return false;
         }
 
-        private void AddItemToPage(NotificationPage page, Item item)
+        private bool CheckAnyMatch(List<AnyOf> anyOfList)
         {
-            if (item is Record record)
-            {
-                new NRecordControl(page, item.Label, item.Indent, record.Value).Add();
-            }
-            else if (item is Link link)
-            {
-                new NLinkControl(page, item.Label, item.Indent, link.Value, MainForm, link.Url).Add();
-            }
-            else if (item is Update update)
-            {
-                new NUpdateControl(page, item.Label, item.Indent, update.Value, MainForm).Add();
-            }
-            else if (item is Heading heading)
-            {
-                new NHeadingControl(page, item.Label, heading.Color).Add();
-            }
-            else if (item is Text text)
+            foreach (var anyOf in anyOfList)
             {
-                new NTextControl(page, item.Label, text.Color).Add();
-            }
-            else if (item is Item item2)
-            {
-                new NTextControl(page, item.Label).Add();
+                if (CheckAllMatch(anyOf.AllOfList)) return true; 
             }
+            return false;
         }
 
         private bool CheckAllMatch(List<Criteria> criteriaList)
@@ -303,29 +274,61 @@ private bool CheckContains(Criteria criteria, bool sense)
             LogCheckContains(criteria.Value, sense, content, result);
             return result;
         }
+        #endregion
 
-        /// <summary>
-        /// Drop any notifications for the channel not selected
-        /// </summary>
-        /// <param name="updateManager"></param>
-        public void DropUnusedUpdateNotifications()
+        private void AddItemToPage(NotificationPage page, Item item)
         {
-            var updateModeSetting = UpdateManager.ChannelName.ToLower();
-            foreach (var n in Notifications.NotificationList)
+            if (item is Record record)
             {
-                if (n.UpdateMode == null)   // Skip notifications which are not updates
-                    continue;
-
-                var lowerUpdateMode = n.UpdateMode.ToLower();
-
-                // If setting == "none", then keep just one update notification, e.g. the stable one
-                if (updateModeSetting == "" && lowerUpdateMode == "stable")
-                    continue;
+                new NRecordControl(page, item.Label, item.Indent, record.Value).Add();
+            }
+            else if (item is Link link)
+            {
+                var url = GetUrl(link);
+                if (string.IsNullOrEmpty(url) == false)
+                {
+                    new NLinkControl(page, item.Label, item.Indent, link.Value, MainForm, url).Add();
+                }
+            }
+            else if (item is Update update)
+            {
+                new NUpdateControl(page, item.Label, item.Indent, update.Value, MainForm).Add();
+            }
+            else if (item is Heading heading)
+            {
+                new NHeadingControl(page, item.Label, heading.Color).Add();
+            }
+            else if (item is Text text)
+            {
+                new NTextControl(page, item.Label, text.Color).Add();
+            }
+            else
+            {
+                new NTextControl(page, item.Label).Add();
+            }
+        }
 
-                // Mark unused updates for deletion outside loop
-                n.ToDelete = lowerUpdateMode != updateModeSetting;
+        private string GetUrl(Link link)
+        {
+            var url = link.Url;
+            if (string.IsNullOrEmpty(url))
+            {
+                switch (UpdateManager.ChannelName.ToLower())
+                {
+                    case "stable":
+                    case "": // Channel None
+                        url = link.StableUrl;
+                        break;
+                    case "testing":
+                        url = link.TestingUrl;
+                        break;
+                    case "unstable":
+                        url = link.UnstableUrl;
+                        break;
+                }
             }
-            Notifications.NotificationList.RemoveAll(n => n.ToDelete);
+
+            return url;
         }
 
         public void ReplaceParameters()
@@ -334,9 +337,10 @@ public void ReplaceParameters()
             {
                 n.Title = ReplaceParameter(n.Title);
                 n.Date = ReplaceParameter(n.Date);
-                n.PrefixItemList?.ForEach(item => ReplaceItemParameter(item));
-                n.Met.ItemList?.ForEach(item => ReplaceItemParameter(item));
-                n.SuffixItemList?.ForEach(item => ReplaceItemParameter(item));
+                //n.PrefixItemList?.ForEach(item => ReplaceItemParameter(item));
+                //n.Met.ItemList?.ForEach(item => ReplaceItemParameter(item));
+                //n.SuffixItemList?.ForEach(item => ReplaceItemParameter(item));
+                n.ItemList?.ForEach(item => ReplaceItemParameter(item));
             }
             foreach (var list in Notifications.CheckList)
             {
@@ -382,7 +386,7 @@ private string ReplaceParameter(string field)
             var parameterArray = field.Split('{', '}'); // 5 elements: prefix, "", target, "", suffix
             var target = parameterArray[2];
             var lowerCaseTarget = parameterArray[2].ToLower();
-            var replacement = parameterArray[2]; // Default is original text
+            string replacement;
 
             // If found in dictionary, then use that else extract it from program
             if (ParameterDictionary.ContainsKey(lowerCaseTarget))
@@ -521,6 +525,7 @@ public OverrideParameterList GetOverrideParameters()
                 return null;
         }
 
+        #region Logging
         public void LogOverrideParameters()
         {
             if (Log == false) return;
@@ -557,14 +562,14 @@ public void LogNotification(Notification n)
         {
             AppendToLog($"Notification: {n.Title}");
         }
-        public void LogChecks(CheckId ci)
+        public void LogChecks(string checkName)
         {
-            AppendToLog($"CheckId: {ci.Id}");
+            AppendToLog($"CheckId: {checkName}");
         }
         public void LogCheckContains(string value, bool sense, string content, bool result)
         {
             var negation = sense ? "" : "NOT ";
-            AppendToLog($"Check: '{value}' {negation}contained in '{content}' = {result}");
+            AppendToLog($"Check: {result} = '{value}' {negation}contained in '{content}'");
         }
 
         public void AppendToLog(string record)
@@ -576,5 +581,6 @@ public void AppendToLog(string record)
                 sw.WriteLine(record);
             }
         }
+        #endregion
     }
 }