Handles all test cases in Notifications.docx

cjakeman · cjakeman · commit 6cf527236a21 · 2024-07-08T15:32:48.000+01:00
diff --git a/Source/Documentation/Notifications.docx b/Source/Documentation/Notifications.docx
diff --git a/Source/Menu/Notifications/NotificationManager.cs b/Source/Menu/Notifications/NotificationManager.cs
@@ -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
@@ -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
@@ -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,94 +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;
-
-            // 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)
-            //{
-            //    n.Met.ItemList?.ForEach(item => AddItemToPage(page, item));
-            //}
-            //else
-            //{
-            //    if (failingCheck.UnmetItemList == null) // Omit this section to skip the notification entirely.
-            //    {
-            //        // Don't skip if there is only one notification.
-            //        if (list.Count > 1) skipPage = true;
-            //    }
-            //    else
-            //    {
-            //        failingCheck.UnmetItemList?.ForEach(item => AddItemToPage(page, item));
-            //    }
-            //}
-            //n.SuffixItemList?.ForEach(item => AddItemToPage(page, item));
-            n.ItemList?.ForEach(item => AddItemToPage(page, item));
-            if (skipPage == false) PageList.Add(page);
-        }
-
-        /// <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)
-        {
-            Check failingCheck = null;
-            foreach (var checkName in n.CheckIdList) // CheckIdList is optional
+            // Check constraints for each item
+            foreach(var item in n.ItemList)
             {
-                LogChecks(checkName);
-
-                // Find the matching check
-                var check = Notifications.CheckList.Where(c => c.Id == checkName).FirstOrDefault();
-                if (check != null && check.AnyOfList.Count() > 0)
-                {
-                    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 (AreChecksMet(item)) AddItemToPage(page, item);
             }
-            return failingCheck;
+            if (skipPage == false) PageList.Add(page);
         }
 
-        private void AddItemToPage(NotificationPage page, Item item)
+        #region Process Criteria
+        private bool AreChecksMet(Item item)
         {
-            if (item is Record record)
+            if (item.IncludeIf != null || item.IncludeIfNot != null)
             {
-                new NRecordControl(page, item.Label, item.Indent, record.Value).Add();
+                AppendToLog($"Label: {item.Label}");
             }
-            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)
+                if (item.IncludeIf != null)
             {
-                new NUpdateControl(page, item.Label, item.Indent, update.Value, MainForm).Add();
+                foreach (var checkName in item.IncludeIf)
+                {
+                    // Include if A=true AND B=true AND ...
+                    if (IsCheckMet(checkName) == false) return false;
+                }
             }
-            else if (item is Heading heading)
+            if (item.IncludeIfNot != null)
             {
-                new NHeadingControl(page, item.Label, heading.Color).Add();
+                foreach (var checkName in item.IncludeIfNot)
+                {
+                    // Include if C=false AND D=false AND ...
+                    if (IsCheckMet(checkName) == true) return false;
+                }
             }
-            else if (item is Text text)
+
+            return true;
+        }
+
+        private bool IsCheckMet(string checkname)
+        {
+            foreach (var check in Notifications.CheckList)
             {
-                new NTextControl(page, item.Label, text.Color).Add();
+                if (check.Id == checkname)
+                {
+                    if (CheckAnyMatch(check.AnyOfList)) return true;
+                }
             }
-            else if (item is Item item2)
+            return false;
+        }
+
+        private bool CheckAnyMatch(List<AnyOf> anyOfList)
+        {
+            foreach (var anyOf in anyOfList)
             {
-                new NTextControl(page, item.Label).Add();
+                if (CheckAllMatch(anyOf.AllOfList)) return true; 
             }
+            return false;
         }
 
         private bool CheckAllMatch(List<Criteria> criteriaList)
@@ -304,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 if (item is Item item2)
+            {
+                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()
@@ -523,6 +525,7 @@ public OverrideParameterList GetOverrideParameters()
                 return null;
         }
 
+        #region Logging
         public void LogOverrideParameters()
         {
             if (Log == false) return;
@@ -566,7 +569,7 @@ public void LogChecks(string 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)
@@ -578,5 +581,6 @@ public void AppendToLog(string record)
                 sw.WriteLine(record);
             }
         }
+        #endregion
     }
 }
diff --git a/Source/Menu/Notifications/Notifications.cs b/Source/Menu/Notifications/Notifications.cs
@@ -16,7 +16,7 @@
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
 using System.Collections.Generic;
-using ORTS.Updater;
+
 
 namespace ORTS
 {
@@ -38,7 +38,6 @@ public class Notification
         public string Title { get; set; }
         public string UpdateMode { get; set; }
         public List<Item> ItemList { get; set; }
-        public List<string> CheckIdList { get; set; }
     }
     class Record : Item
     {
@@ -55,6 +54,9 @@ class Link : Item
     {
         public string Value { get; set; }
         public string Url { get; set; }
+        public string StableUrl { get; set; }
+        public string TestingUrl { get; set; }
+        public string UnstableUrl { get; set; }
     }
     class Update : Item
     {
@@ -63,6 +65,8 @@ class Update : Item
     }
     public class Item
     {
+        public List<string> IncludeIf { get; set; }
+        public List<string> IncludeIfNot { get; set; }
         public string Label { get; set; }
         public string Color { get; set; } = "black";
         public int Indent { get; set; } = 140;
@@ -80,15 +84,15 @@ public class Item
     public class Check
     {
         public string Id { get; set; }
-        public List<AllOf> AnyOfList { get; set; }
+        public List<AnyOf> AnyOfList { get; set; }
         //public List<Item> UnmetItemList { get; set; }
     }
 
     //public class CheckAllOf
     //{
     //    public List<Criteria> AllOfList { get; set; }
     //}
-    public class AllOf
+    public class AnyOf
     {
         public List<Criteria> AllOfList { get; set; }
     }

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`// along with Open Rails. If not, see <http://www.gnu.org/licenses/>.`
`17`	`17`
`18`	`18`	`using System.Collections.Generic;`
`19`		`-using ORTS.Updater;`
	`19`	`+`
`20`	`20`
`21`	`21`	`namespace ORTS`
`22`	`22`	`{`
`@@ -38,7 +38,6 @@ public class Notification`
`38`	`38`	`public string Title { get; set; }`
`39`	`39`	`public string UpdateMode { get; set; }`
`40`	`40`	`public List<Item> ItemList { get; set; }`
`41`		`- public List<string> CheckIdList { get; set; }`
`42`	`41`	`}`
`43`	`42`	`class Record : Item`
`44`	`43`	`{`
`@@ -55,6 +54,9 @@ class Link : Item`
`55`	`54`	`{`
`56`	`55`	`public string Value { get; set; }`
`57`	`56`	`public string Url { get; set; }`
	`57`	`+ public string StableUrl { get; set; }`
	`58`	`+ public string TestingUrl { get; set; }`
	`59`	`+ public string UnstableUrl { get; set; }`
`58`	`60`	`}`
`59`	`61`	`class Update : Item`
`60`	`62`	`{`
`@@ -63,6 +65,8 @@ class Update : Item`
`63`	`65`	`}`
`64`	`66`	`public class Item`
`65`	`67`	`{`
	`68`	`+ public List<string> IncludeIf { get; set; }`
	`69`	`+ public List<string> IncludeIfNot { get; set; }`
`66`	`70`	`public string Label { get; set; }`
`67`	`71`	`public string Color { get; set; } = "black";`
`68`	`72`	`public int Indent { get; set; } = 140;`
`@@ -80,15 +84,15 @@ public class Item`
`80`	`84`	`public class Check`
`81`	`85`	`{`
`82`	`86`	`public string Id { get; set; }`
`83`		`- public List<AllOf> AnyOfList { get; set; }`
	`87`	`+ public List<AnyOf> AnyOfList { get; set; }`
`84`	`88`	`//public List<Item> UnmetItemList { get; set; }`
`85`	`89`	`}`
`86`	`90`
`87`	`91`	`//public class CheckAllOf`
`88`	`92`	`//{`
`89`	`93`	`// public List<Criteria> AllOfList { get; set; }`
`90`	`94`	`//}`
`91`		`- public class AllOf`
	`95`	`+ public class AnyOf`
`92`	`96`	`{`
`93`	`97`	`public List<Criteria> AllOfList { get; set; }`
`94`	`98`	`}`