Adds IncludesAllOf() and ExcludesAnyOf().

cjakeman · cjakeman · commit 0a956f5441f7 · 2024-04-06T11:21:36.000+01:00
Adds local menu_test.json for testing changes.
diff --git a/Source/Menu/Notifications/NotificationManager.cs b/Source/Menu/Notifications/NotificationManager.cs
@@ -76,9 +76,9 @@ public void CheckNotifications()
         public Notifications GetNotifications()
         {
             String notificationsSerial;
-            // To support testing of a new menu.json file, GetNotifications tests for a local file first and uses that if present.
+            // To support testing of a new menu.json file, GetNotifications tests for a local file test.json first and uses that if present.
 
-            var filename = @"menu.json";
+            var filename = @"menu_test.json";
             if (System.IO.File.Exists(filename))
             {
                 // Input from local file into a string
@@ -97,7 +97,8 @@ public Notifications GetNotifications()
         }
 
         /// <summary>
-        /// Fetch the Notifications from https://static.openrails.org/notifications/menu.json
+        /// Fetch the Notifications from     https://static.openrails.org/api/notifications/menu.json 
+        /// This file is copied hourly from Github openrails/notifications/
         /// </summary>
         private string GetRemoteJson()
         {
@@ -109,12 +110,6 @@ private string GetRemoteJson()
             // Helpful to supply server with data for its log file.
             client.Headers[HttpRequestHeader.UserAgent] = $"{System.Windows.Forms.Application.ProductName}/{VersionInfo.VersionOrBuild}";
 
-            // Trial for glTD and PBR graphics
-            //return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications/menu_testing_direct3d.json"));
-
-            // Trial for UserSettings
-            //return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications/menu_testing_user_settings.json"));
-
             return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications/menu.json"));
         }
 
@@ -128,7 +123,7 @@ public void PopulatePageList()
         }
 
         /// <summary>
-        /// Ultimately there will be a list of notifications downloaded from openrails/content.
+        /// 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()
@@ -186,61 +181,79 @@ void SetUpdateNotificationPage()
         }
 
         /// <summary>
-        /// IncludesAnyOf() implements D == d OR E == e OR ...
+        /// ExcludesAnyOf() implements A != a OR B != b AND ...
         /// ExcludesAllOf() implements A != a AND B != b AND ...
-        /// CheckConstraints() implements ExcludesAnyOf() AND IncludesAnyOf(), but all parts are optional.
+        /// IncludesAnyOf() implements D == d OR E == e OR ...
+        /// IncludesAllOf() implements D == d AND E == e OR ...
+        /// CheckConstraints() implements ExcludesAnyOf() AND ExcludesAllOf() AND IncludesAnyOf() AND IncludesAllOf(), but all parts are optional.
         /// </summary>
         /// <param name="page"></param>
         /// <param name="n"></param>
         private void CheckConstraints(NotificationPage page, Notification n)
         {
-            var excludesMet = true;
-            var includesMet = true;
             foreach (var nc in n.MetLists.CheckIdList)
             {
-                foreach (var c in Notifications.CheckList.Where(c => c.Id == nc.Id))
+                // Find the matching check
+                var c = Notifications.CheckList.Where(check => check.Id == nc.Id).FirstOrDefault();
+                if (c != null)
                 {
-                    if (c.ExcludesAllOf == null)    // ExcludesAnyOf is optional
-                        excludesMet = true;
-                    else
+                    // Check the ALL constraints
+                    if (c.ExcludesAllOf != null)    // ExcludesAllOf is optional
                     {
-                        var checkFailed = CheckExcludes(c);
-                        excludesMet = (checkFailed == null);
-                        if (excludesMet == false)
+                        var checkFailed = CheckMatch(c, c.ExcludesAllOf);
+                        if (checkFailed != null)
                         {
                             foreach (var item in checkFailed.UnmetItemList)
                             {
                                 AddItemToPage(page, item);
                             }
-                            break;
+                            return;
                         }
                     }
 
-                    if (c.IncludesAnyOf == null)    // IncludesAnyOf is optional
-                        includesMet = true;
-                    else
+                    // NOT TESTED YET
+                    //if (c.IncludesAllOf != null)    // IncludesAllOf is optional
+                    //{
+                    //    var checkFailed = CheckAll(c, c.IncludesAllOf);
+                    //    if (checkFailed != null)
+                    //    {
+                    //        foreach (var item in checkFailed.UnmetItemList)
+                    //        {
+                    //            AddItemToPage(page, item);
+                    //        }
+                    //        return;
+                    //    }
+                    //}
+
+                    // Check the ANY constraints
+                    if (c.ExcludesAnyOf != null)    // ExcludesAnyOf is optional
                     {
-                        var checkPassed = CheckIncludes(c);
-                        includesMet = (checkPassed != null);
-                        if (includesMet == false)
+                        if (CheckMatch(c, c.ExcludesAnyOf) != null)
                         {
                             foreach (var item in c.UnmetItemList)
                             {
                                 AddItemToPage(page, item);
                             }
-                            break;
+                            return;
+                        }
+                    }
+
+                    if (c.IncludesAnyOf != null)    // IncludesAnyOf is optional
+                    {
+                        if (CheckMatch(c, c.IncludesAnyOf) == null)
+                        {
+                            foreach (var item in c.UnmetItemList)
+                            {
+                                AddItemToPage(page, item);
+                            }
+                            return;
                         }
                     }
                 }
-                if (excludesMet == false || includesMet == false)
-                    break;
             }
-            if (excludesMet && includesMet)
+            foreach (var item in n.MetLists.ItemList)
             {
-                foreach (var item in n.MetLists.ItemList)
-                {
-                    AddItemToPage(page, item);
-                }
+                AddItemToPage(page, item);
             }
         }
 
@@ -269,34 +282,39 @@ private void AddItemToPage(NotificationPage page, Item item)
         }
 
         /// <summary>
-        /// Returns any check that fails.
+        /// Returns null or the first check that matches.
         /// </summary>
         /// <param name="check"></param>
         /// <returns></returns>
-        private Check CheckExcludes(Check check)
+        private Check CheckMatch(Check check, List<Criteria> criteriaList)
         {
-            foreach (var c in check.ExcludesAllOf)
+            foreach (var c in criteriaList)
             {
-                if (c is Contains) // Other criteria might be added such as greater_than and less_than
+                if (c is Contains) // Other criteria might be added such as NoLessThan and NoMoreThan.
                 {
-                    return CheckContains(check, c);
+                    var matchedCheck = CheckContains(check, c);
+                    if (matchedCheck != null)
+                        return matchedCheck;
                 }
             }
             return null;
         }
 
         /// <summary>
-        /// Returns any check that succeeds.
+        /// Returns null or the first check that does not match.
         /// </summary>
         /// <param name="check"></param>
         /// <returns></returns>
-        private Check CheckIncludes(Check check)
+        private Check CheckNoMatch(Check check, List<Criteria> criteriaList)
         {
-            foreach (var c in check.IncludesAnyOf)
+            foreach (var c in criteriaList)
             {
-                if (c is Contains)
+                if (c is Contains) // Other criteria might be added such as NoLessThan and NoMoreThan.
                 {
-                    return CheckContains(check, c);
+                    if (CheckContains(check, c) == null)
+                    {
+                        return check;
+                    }
                 }
             }
             return null;
@@ -311,8 +329,7 @@ private Check CheckContains(Check check, Criteria c)
                         return check;
                     break;
                 case "installed_version":
-                    if (c.Value == "none" // as Update Mode == "none"
-                    || SystemInfo.Application.Version.IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)
+                    if (SystemInfo.Application.Version.IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)
                         return check;
                     break;
                 case "system":
@@ -321,7 +338,7 @@ private Check CheckContains(Check check, Criteria c)
                     if (system.IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)
                         return check;
                     break;
-                default: 
+                default:
                     if (GetSetting(c.Name).IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)
                     {
                         return check;
@@ -388,6 +405,8 @@ public void ReplaceParameters()
             foreach (var c in Notifications.CheckList)
             {
                 c.ExcludesAllOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));
+                c.IncludesAllOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));
+                c.ExcludesAnyOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));
                 c.IncludesAnyOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));
             }
         }
diff --git a/Source/Menu/Notifications/Notifications.cs b/Source/Menu/Notifications/Notifications.cs
@@ -82,14 +82,20 @@ public class Check
     {
         public string Id { get; set; }
         public List<Criteria> IncludesAnyOf { get; set; }
+        public List<Criteria> IncludesAllOf { get; set; }
+        public List<Criteria> ExcludesAnyOf { get; set; }
         public List<Criteria> ExcludesAllOf { get; set; }
         public List<Item> UnmetItemList { get; set; }
         public bool IsChecked { get; set; } = false;
         public bool IsMet { get; set; } = false;
     }
     class Contains : Criteria { }
+    
+    // Not implemented yet
+    // String comparison, not numerical
     class NoLessThan : Criteria { }
     class NoMoreThan : Criteria { }
+    
     public class Criteria
     {
         // System Information "examples"

Original file line number	Diff line number	Diff line change
`@@ -76,9 +76,9 @@ public void CheckNotifications()`
`76`	`76`	`public Notifications GetNotifications()`
`77`	`77`	`{`
`78`	`78`	`String notificationsSerial;`
`79`		`- // To support testing of a new menu.json file, GetNotifications tests for a local file first and uses that if present.`
	`79`	`+ // To support testing of a new menu.json file, GetNotifications tests for a local file test.json first and uses that if present.`
`80`	`80`
`81`		`- var filename = @"menu.json";`
	`81`	`+ var filename = @"menu_test.json";`
`82`	`82`	`if (System.IO.File.Exists(filename))`
`83`	`83`	`{`
`84`	`84`	`// Input from local file into a string`
`@@ -97,7 +97,8 @@ public Notifications GetNotifications()`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`/// <summary>`
`100`		`- /// Fetch the Notifications from https://static.openrails.org/notifications/menu.json`
	`100`	`+ /// Fetch the Notifications from https://static.openrails.org/api/notifications/menu.json`
	`101`	`+ /// This file is copied hourly from Github openrails/notifications/`
`101`	`102`	`/// </summary>`
`102`	`103`	`private string GetRemoteJson()`
`103`	`104`	`{`
`@@ -109,12 +110,6 @@ private string GetRemoteJson()`
`109`	`110`	`// Helpful to supply server with data for its log file.`
`110`	`111`	`client.Headers[HttpRequestHeader.UserAgent] = $"{System.Windows.Forms.Application.ProductName}/{VersionInfo.VersionOrBuild}";`
`111`	`112`
`112`		`- // Trial for glTD and PBR graphics`
`113`		`- //return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications/menu_testing_direct3d.json"));`
`114`		`-`
`115`		`- // Trial for UserSettings`
`116`		`- //return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications/menu_testing_user_settings.json"));`
`117`		`-`
`118`	`113`	`return client.DownloadString(new Uri("https://wepp.co.uk/openrails/notifications/menu.json"));`
`119`	`114`	`}`
`120`	`115`
`@@ -128,7 +123,7 @@ public void PopulatePageList()`
`128`	`123`	`}`
`129`	`124`
`130`	`125`	`/// <summary>`
`131`		`- /// Ultimately there will be a list of notifications downloaded from openrails/content.`
	`126`	`+ /// Ultimately there will be a list of notifications downloaded from https://static.openrails.org/api/notifications/menu.json .`
`132`	`127`	`/// Until then, there is a single notification announcing either that a new update is available or the installation is up to date.`
`133`	`128`	`/// </summary>`
`134`	`129`	`void SetUpdateNotificationPage()`
`@@ -186,61 +181,79 @@ void SetUpdateNotificationPage()`
`186`	`181`	`}`
`187`	`182`
`188`	`183`	`/// <summary>`
`189`		`- /// IncludesAnyOf() implements D == d OR E == e OR ...`
	`184`	`+ /// ExcludesAnyOf() implements A != a OR B != b AND ...`
`190`	`185`	`/// ExcludesAllOf() implements A != a AND B != b AND ...`
`191`		`- /// CheckConstraints() implements ExcludesAnyOf() AND IncludesAnyOf(), but all parts are optional.`
	`186`	`+ /// IncludesAnyOf() implements D == d OR E == e OR ...`
	`187`	`+ /// IncludesAllOf() implements D == d AND E == e OR ...`
	`188`	`+ /// CheckConstraints() implements ExcludesAnyOf() AND ExcludesAllOf() AND IncludesAnyOf() AND IncludesAllOf(), but all parts are optional.`
`192`	`189`	`/// </summary>`
`193`	`190`	`/// <param name="page"></param>`
`194`	`191`	`/// <param name="n"></param>`
`195`	`192`	`private void CheckConstraints(NotificationPage page, Notification n)`
`196`	`193`	`{`
`197`		`- var excludesMet = true;`
`198`		`- var includesMet = true;`
`199`	`194`	`foreach (var nc in n.MetLists.CheckIdList)`
`200`	`195`	`{`
`201`		`- foreach (var c in Notifications.CheckList.Where(c => c.Id == nc.Id))`
	`196`	`+ // Find the matching check`
	`197`	`+ var c = Notifications.CheckList.Where(check => check.Id == nc.Id).FirstOrDefault();`
	`198`	`+ if (c != null)`
`202`	`199`	`{`
`203`		`- if (c.ExcludesAllOf == null) // ExcludesAnyOf is optional`
`204`		`- excludesMet = true;`
`205`		`- else`
	`200`	`+ // Check the ALL constraints`
	`201`	`+ if (c.ExcludesAllOf != null) // ExcludesAllOf is optional`
`206`	`202`	`{`
`207`		`- var checkFailed = CheckExcludes(c);`
`208`		`- excludesMet = (checkFailed == null);`
`209`		`- if (excludesMet == false)`
	`203`	`+ var checkFailed = CheckMatch(c, c.ExcludesAllOf);`
	`204`	`+ if (checkFailed != null)`
`210`	`205`	`{`
`211`	`206`	`foreach (var item in checkFailed.UnmetItemList)`
`212`	`207`	`{`
`213`	`208`	`AddItemToPage(page, item);`
`214`	`209`	`}`
`215`		`- break;`
	`210`	`+ return;`
`216`	`211`	`}`
`217`	`212`	`}`
`218`	`213`
`219`		`- if (c.IncludesAnyOf == null) // IncludesAnyOf is optional`
`220`		`- includesMet = true;`
`221`		`- else`
	`214`	`+ // NOT TESTED YET`
	`215`	`+ //if (c.IncludesAllOf != null) // IncludesAllOf is optional`
	`216`	`+ //{`
	`217`	`+ // var checkFailed = CheckAll(c, c.IncludesAllOf);`
	`218`	`+ // if (checkFailed != null)`
	`219`	`+ // {`
	`220`	`+ // foreach (var item in checkFailed.UnmetItemList)`
	`221`	`+ // {`
	`222`	`+ // AddItemToPage(page, item);`
	`223`	`+ // }`
	`224`	`+ // return;`
	`225`	`+ // }`
	`226`	`+ //}`
	`227`	`+`
	`228`	`+ // Check the ANY constraints`
	`229`	`+ if (c.ExcludesAnyOf != null) // ExcludesAnyOf is optional`
`222`	`230`	`{`
`223`		`- var checkPassed = CheckIncludes(c);`
`224`		`- includesMet = (checkPassed != null);`
`225`		`- if (includesMet == false)`
	`231`	`+ if (CheckMatch(c, c.ExcludesAnyOf) != null)`
`226`	`232`	`{`
`227`	`233`	`foreach (var item in c.UnmetItemList)`
`228`	`234`	`{`
`229`	`235`	`AddItemToPage(page, item);`
`230`	`236`	`}`
`231`		`- break;`
	`237`	`+ return;`
	`238`	`+ }`
	`239`	`+ }`
	`240`	`+`
	`241`	`+ if (c.IncludesAnyOf != null) // IncludesAnyOf is optional`
	`242`	`+ {`
	`243`	`+ if (CheckMatch(c, c.IncludesAnyOf) == null)`
	`244`	`+ {`
	`245`	`+ foreach (var item in c.UnmetItemList)`
	`246`	`+ {`
	`247`	`+ AddItemToPage(page, item);`
	`248`	`+ }`
	`249`	`+ return;`
`232`	`250`	`}`
`233`	`251`	`}`
`234`	`252`	`}`
`235`		`- if (excludesMet == false \|\| includesMet == false)`
`236`		`- break;`
`237`	`253`	`}`
`238`		`- if (excludesMet && includesMet)`
	`254`	`+ foreach (var item in n.MetLists.ItemList)`
`239`	`255`	`{`
`240`		`- foreach (var item in n.MetLists.ItemList)`
`241`		`- {`
`242`		`- AddItemToPage(page, item);`
`243`		`- }`
	`256`	`+ AddItemToPage(page, item);`
`244`	`257`	`}`
`245`	`258`	`}`
`246`	`259`
`@@ -269,34 +282,39 @@ private void AddItemToPage(NotificationPage page, Item item)`
`269`	`282`	`}`
`270`	`283`
`271`	`284`	`/// <summary>`
`272`		`- /// Returns any check that fails.`
	`285`	`+ /// Returns null or the first check that matches.`
`273`	`286`	`/// </summary>`
`274`	`287`	`/// <param name="check"></param>`
`275`	`288`	`/// <returns></returns>`
`276`		`- private Check CheckExcludes(Check check)`
	`289`	`+ private Check CheckMatch(Check check, List<Criteria> criteriaList)`
`277`	`290`	`{`
`278`		`- foreach (var c in check.ExcludesAllOf)`
	`291`	`+ foreach (var c in criteriaList)`
`279`	`292`	`{`
`280`		`- if (c is Contains) // Other criteria might be added such as greater_than and less_than`
	`293`	`+ if (c is Contains) // Other criteria might be added such as NoLessThan and NoMoreThan.`
`281`	`294`	`{`
`282`		`- return CheckContains(check, c);`
	`295`	`+ var matchedCheck = CheckContains(check, c);`
	`296`	`+ if (matchedCheck != null)`
	`297`	`+ return matchedCheck;`
`283`	`298`	`}`
`284`	`299`	`}`
`285`	`300`	`return null;`
`286`	`301`	`}`
`287`	`302`
`288`	`303`	`/// <summary>`
`289`		`- /// Returns any check that succeeds.`
	`304`	`+ /// Returns null or the first check that does not match.`
`290`	`305`	`/// </summary>`
`291`	`306`	`/// <param name="check"></param>`
`292`	`307`	`/// <returns></returns>`
`293`		`- private Check CheckIncludes(Check check)`
	`308`	`+ private Check CheckNoMatch(Check check, List<Criteria> criteriaList)`
`294`	`309`	`{`
`295`		`- foreach (var c in check.IncludesAnyOf)`
	`310`	`+ foreach (var c in criteriaList)`
`296`	`311`	`{`
`297`		`- if (c is Contains)`
	`312`	`+ if (c is Contains) // Other criteria might be added such as NoLessThan and NoMoreThan.`
`298`	`313`	`{`
`299`		`- return CheckContains(check, c);`
	`314`	`+ if (CheckContains(check, c) == null)`
	`315`	`+ {`
	`316`	`+ return check;`
	`317`	`+ }`
`300`	`318`	`}`
`301`	`319`	`}`
`302`	`320`	`return null;`
`@@ -311,8 +329,7 @@ private Check CheckContains(Check check, Criteria c)`
`311`	`329`	`return check;`
`312`	`330`	`break;`
`313`	`331`	`case "installed_version":`
`314`		`- if (c.Value == "none" // as Update Mode == "none"`
`315`		`- \|\| SystemInfo.Application.Version.IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)`
	`332`	`+ if (SystemInfo.Application.Version.IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)`
`316`	`333`	`return check;`
`317`	`334`	`break;`
`318`	`335`	`case "system":`
`@@ -321,7 +338,7 @@ private Check CheckContains(Check check, Criteria c)`
`321`	`338`	`if (system.IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)`
`322`	`339`	`return check;`
`323`	`340`	`break;`
`324`		`- default:`
	`341`	`+ default:`
`325`	`342`	`if (GetSetting(c.Name).IndexOf(c.Value, StringComparison.OrdinalIgnoreCase) > -1)`
`326`	`343`	`{`
`327`	`344`	`return check;`
`@@ -388,6 +405,8 @@ public void ReplaceParameters()`
`388`	`405`	`foreach (var c in Notifications.CheckList)`
`389`	`406`	`{`
`390`	`407`	`c.ExcludesAllOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));`
	`408`	`+ c.IncludesAllOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));`
	`409`	`+ c.ExcludesAnyOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));`
`391`	`410`	`c.IncludesAnyOf?.ForEach(criteria => ReplaceCriteriaParameter(criteria));`
`392`	`411`	`}`
`393`	`412`	`}`