CA-386317: Use localized value to override data source descriptions

Signed-off-by: Danilo Del Busso <[email protected]>
xenserver · Dec 4, 2023 · 9866f01 · 9866f01
1 parent 91a6c25
commit 9866f01
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 15 deletions.
diff --git a/XenAdmin/Controls/CustomDataGraph/GraphHelpers.cs b/XenAdmin/Controls/CustomDataGraph/GraphHelpers.cs
@@ -183,16 +183,11 @@ public static List<DataSourceItem> BuildList(IXenObject xenObject, List<Data_sou
                 if (dataSource.name_label == "memory_total_kib" || dataSource.name_label == "memory")
                     continue;
 
-                string friendlyName;
-                if (dataSource.name_label == "memory_free_kib" && xenObject is Host)
-                    friendlyName = Helpers.GetFriendlyDataSourceName("memory_used_kib", xenObject);
-                else if (dataSource.name_label == "memory_internal_free" && xenObject is VM)
-                    friendlyName = Helpers.GetFriendlyDataSourceName("memory_internal_used", xenObject);
-                else
-                    friendlyName = Helpers.GetFriendlyDataSourceName(dataSource.name_label, xenObject);
-
-                string itemUuid = Palette.GetUuid(dataSource.name_label, xenObject);
-                dataSourceItems.Add(new DataSourceItem(dataSource, friendlyName, Palette.GetColour(itemUuid), itemUuid));
+                var friendlyName = Helpers.GetFriendlyDataSourceName(dataSource.name_label, xenObject) ?? dataSource.name_label;
+                var friendlyDescription = Helpers.GetFriendlyDataSourceDescription(dataSource.name_label, xenObject) ?? dataSource.name_description;
+
+                var itemUuid = Palette.GetUuid(dataSource.name_label, xenObject);
+                dataSourceItems.Add(new DataSourceItem(dataSource, friendlyName, friendlyDescription, Palette.GetColour(itemUuid), itemUuid));
             }
 
             // Filter old datasources only if we have their replacement ones

diff --git a/XenModel/FriendlyNameManager.cs b/XenModel/FriendlyNameManager.cs
@@ -42,11 +42,12 @@ public class FriendlyNameManager
         /// <summary>
         /// Returns null if no match is found.
         /// </summary>
-        public static string GetFriendlyName(string s)
+        public static string GetFriendlyName(string s, bool ignoreAssert = false)
         {
             var result = FriendlyNames.GetString(s);
 #if DEBUG
-            Debug.Assert(result != null, $"{s} doesn't exist in FriendlyNames");
+            if(!ignoreAssert)
+                Debug.Assert(result != null, $"{s} doesn't exist in FriendlyNames");
 #endif
             switch (s)
             {

diff --git a/XenModel/FriendlyNames.Designer.cs b/XenModel/FriendlyNames.Designer.cs
diff --git a/XenModel/FriendlyNames.resx b/XenModel/FriendlyNames.resx
@@ -303,6 +303,12 @@
   <data name="Description-host.system_status-yum" xml:space="preserve">
     <value>YUM repository information and RPM package database listing</value>
   </data>
+  <data name="Description-performance.memory_internal_used" xml:space="preserve">
+    <value>Memory used as reported by the guest agent</value>
+  </data>
+  <data name="Description-performance.memory_used_kib" xml:space="preserve">
+    <value>Total amount of used memory</value>
+  </data>
   <data name="Description-VM.ha_restart_priority.AlwaysRestart" xml:space="preserve">
     <value>Always try to restart VM</value>
   </data>

diff --git a/XenModel/Utils/Helpers.cs b/XenModel/Utils/Helpers.cs
@@ -719,12 +719,34 @@ public static DataSourceCategory GetDataSourceCategory(string name)
             return DataSourceCategory.Custom;
         }
 
+        private static string GetDataSourceId(string originalId)
+        {
+            switch (originalId)
+            {
+                case "memory_free_kib":
+                    return "memory_used_kib";
+                case "memory_internal_free":
+                    return "memory_internal_used";
+                default:
+                    return originalId;
+            }
+        }
+
+        public static string GetFriendlyDataSourceDescription(string name, IXenObject iXenObject)
+        {
+            var id = GetDataSourceId(name);
+            // suppressing the assert check since we don't support localization anymore, so there's no need to override all descriptions.
+            return iXenObject == null ? id : FriendlyNameManager.GetFriendlyName($"Description-performance.{id}", true);
+        }
+
         public static string GetFriendlyDataSourceName(string name, IXenObject iXenObject)
         {
+            var id = GetDataSourceId(name);
             if (iXenObject == null)
-                return name;
-            string s = GetFriendlyDataSourceName_(name, iXenObject);
-            return string.IsNullOrEmpty(s) ? name : s;
+                return id;
+
+            var friendlyDataSourceName = GetFriendlyDataSourceName_(id, iXenObject);
+            return string.IsNullOrEmpty(friendlyDataSourceName) ? id : friendlyDataSourceName;
         }
 
         private static string GetFriendlyDataSourceName_(string name, IXenObject iXenObject)