Merge pull request #1058 from twpol/refactor/notification-parameters

Refactor notification parameters

Author: cjakeman

Source/Menu/Notifications/NotificationManager.cs

@@ -133,7 +133,7 @@ public void CheckNotifications()
             }
         }
 
-        public Notifications GetNotifications()
+        Notifications GetNotifications()
         {
             string notificationsSerial;
 
@@ -437,68 +437,37 @@ private string GetUrl(Link link)
             return url;
         }
 
-        public void ReplaceParameters()
+        void ReplaceParameters()
         {
-            foreach (var n in Notifications.NotificationList)
-            {
-                n.Title = ReplaceParameter(n.Title);
-                n.Date = ReplaceParameter(n.Date);
-                n.ItemList?.ForEach(item => ReplaceItemParameter(item));
-            }
-            foreach (var list in Notifications.CheckList)
-            {
-                foreach(var c in list?.AnyOfList)
-                {
-                    c?.AllOfList.ForEach(criteria => ReplaceCriteriaPropertyParameter(criteria));
-                    c?.AllOfList.ForEach(criteria => ReplaceCriteriaValueParameter(criteria));
-                }
-            }
+            Notifications.ReplaceParameters(ReplaceParameterValues);
         }
 
-        private void ReplaceItemParameter(Item item)
-        {
-            if (item is Record record)
-                record.Value = ReplaceParameter(record.Value);
-            if (item is Link link)
-                link.Value = ReplaceParameter(link.Value);
-            if (item is Update update)
-                update.Value = ReplaceParameter(update.Value);
-        }
-
-        /// <summary>
-        /// If Property is a parameter, remove {{..}} and add it and its replacement to the dictionary.
-        /// </summary>
-        /// <param name="criteria"></param>
-        private void ReplaceCriteriaPropertyParameter(Criteria criteria)
+        string ReplaceParameterValues(string value)
         {
-            if (ContainsParameter(criteria.Property))
+            if (value == null) return value;
+            var start = 0;
+            while ((start = value.IndexOf("{{", start)) >= 0)
             {
-                criteria.Property = ReplaceParameter(criteria.Property);
+                var end = value.IndexOf("}}", start);
+                if (end == -1) break;
+                var variable = value.Substring(start + 2, end - start - 2);
+                var replacement = GetParameterValue(variable);
+                value = value.Substring(0, start) + replacement + value.Substring(end + 2);
+                start += replacement.Length;
             }
+            return value;
         }
 
-        private void ReplaceCriteriaValueParameter(Criteria criteria)
-        {
-            criteria.Value = ReplaceParameter(criteria.Value);
-        }
-
-        private string ReplaceParameter(string field)
+        string GetParameterValue(string parameter)
         {
-            if (ContainsParameter(field) == false) return field;
-
-            var parameterArray = field.Split('{', '}'); // 5 elements: prefix, "", target, "", suffix
-            var target = parameterArray[2];
-            var lowerCaseTarget = parameterArray[2].ToLower();
             string replacement;
-
-            // If found in dictionary, then use that else extract it from program
-            if (ParameterDictionary.ContainsKey(lowerCaseTarget))
+            if (ParameterDictionary.ContainsKey(parameter))
             {
-                replacement = ParameterDictionary[lowerCaseTarget];
+                replacement = ParameterDictionary[parameter];
             }
             else
             {
-                switch (lowerCaseTarget)
+                switch (parameter)
                 {
                     // Update parameters
                     // Using "none" instead of "" so that records are readable.
@@ -555,23 +524,15 @@ private string ReplaceParameter(string field)
                         replacement = GetInstalledRoutes();
                         break;
                     default:
-                        var propertyValue = GetSetting(target);
+                        var propertyValue = GetSetting(parameter);
                         replacement = (propertyValue == "")
-                            ? field     // strings that are not recognised are not replaced.
+                            ? "{{" + parameter + "}}"     // strings that are not recognised are not replaced.
                             : propertyValue.ToLower().Replace("false", "off").Replace("true", "on");
                         break;
                 }
-                ParameterDictionary.Add(lowerCaseTarget, replacement);
+                ParameterDictionary.Add(parameter, replacement);
             }
-
-            return parameterArray[0] + replacement + parameterArray[4];
-        }
-
-        private bool ContainsParameter(string field)
-        {
-            if (field.Contains("{{") == false) return false;
-            if (field.Contains("}}") == false) return false;
-            return true;
+            return replacement;
         }
 
         /// <summary>
@@ -617,7 +578,7 @@ private string GetInstalledRoutes()
             return installedRouteList;
         }
 
-        public OverrideParameterList GetOverrideParameters()
+        OverrideParameterList GetOverrideParameters()
         {
             // To support testing of a new remote notifications.json file before it is published,
             // GetNotifications tests first for a local file notifications_override_values.json

Source/Menu/Notifications/Notifications.cs

@@ -15,35 +15,38 @@
 // You should have received a copy of the GNU General Public License
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
+using System;
 using System.Collections.Generic;
 
-
 namespace Menu.Notifications
 {
     public class Notifications
     {
         public List<Notification> NotificationList = new List<Notification>();
         public List<Check> CheckList = new List<Check>();
-    }
-
-    class JsonInput
-    {
-        public List<Notification> NotificationList { get; set; }
-        public List<Check> CheckList { get; set; }
+        internal void ReplaceParameters(Func<string, string> replaceFunc)
+        {
+            NotificationList?.ForEach(item => item.ReplaceParameters(replaceFunc));
+            CheckList?.ForEach(item => item.ReplaceParameters(replaceFunc));
+        }
     }
 
     public class Notification
     {
         public string Date { get; set; }
         public string Title { get; set; }
-        public string UpdateMode { get; set; }
         public List<string> IncludeIf { get; set; }
         public List<string> IncludeIfNot { get; set; }
         public List<Item> ItemList { get; set; }
+        internal void ReplaceParameters(Func<string, string> replaceFunc)
+        {
+            Date = replaceFunc(Date);
+            Title = replaceFunc(Title);
+            ItemList?.ForEach(item => item.ReplaceParameters(replaceFunc));
+        }
     }
-    class Record : Item
+    class Record : ValueItem
     {
-        public string Value { get; set; }
     }
     class Text : Item
     {
@@ -52,42 +55,59 @@ class Heading : Item
     {
         public new string Color { get; set; } = "blue";
     }
-    class Link : Item
+    class Link : ValueItem
     {
-        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 Dialog : Item
+    class Dialog : ValueItem
     {
-        public string Value { get; set; }
         public string Form { get; set; }
     }
-    class Update : Item
+    class Update : ValueItem
+    {
+    }
+    abstract class ValueItem : Item
     {
         public string Value { get; set; }
-        public string UpdateMode { get; set; }
+        internal override void ReplaceParameters(Func<string, string> replaceFunc)
+        {
+            base.ReplaceParameters(replaceFunc);
+            Value = replaceFunc(Value);
+        }
     }
-    public class Item
+    public abstract 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;
+        internal virtual void ReplaceParameters(Func<string, string> replaceFunc)
+        {
+            Label = replaceFunc(Label);
+        }
     }
 
     public class Check
     {
         public string Id { get; set; }
         public List<AnyOf> AnyOfList { get; set; }
+        internal void ReplaceParameters(Func<string, string> replaceFunc)
+        {
+            AnyOfList?.ForEach(item => item.ReplaceParameters(replaceFunc));
+        }
     }
 
     public class AnyOf
     {
         public List<Criteria> AllOfList { get; set; }
+        internal void ReplaceParameters(Func<string, string> replaceFunc)
+        {
+            AllOfList?.ForEach(item => item.ReplaceParameters(replaceFunc));
+        }
     }
 
     // These criteria are all doing an actual comparison
@@ -114,15 +134,20 @@ public abstract class Criteria
         public string Property { get; set; }    // installed_version, direct3d, runtime, system, memory, cpu, gpu
         public string Value { get; set; }       // {{new_version}}, {{10_0}}
         public abstract bool IsMatch();
+        internal void ReplaceParameters(Func<string, string> replaceFunc)
+        {
+            Property = replaceFunc(Property);
+            Value = replaceFunc(Value);
+        }
     }
 
-    public class ParameterValue
+    class ParameterValue
     {
         public string Parameter { get; set; }    // installed_version, direct3d, runtime, system, memory, cpu, gpu
         public string Value { get; set; }       // {{new_version}}, {{10_0}}
     }
 
-    public class OverrideParameterList
+    class OverrideParameterList
     {
         public List<ParameterValue> ParameterValueList = new List<ParameterValue>();
     }