fix(2398): don't unsafely grab strings from ItemOptions.RarityTiers (#2441)

* fix: don't unsafely grab strings from ItemOptions.RarityTiers

* fix: prevent editor from having an index-out-of-range exception

Author: pandinocoder

Intersect (Core)/Config/ItemOptions.cs

@@ -1,3 +1,4 @@
+using System.Diagnostics.CodeAnalysis;
 using Newtonsoft.Json;
 
 namespace Intersect.Config;
@@ -10,14 +11,21 @@ public class ItemOptions
     /// <summary>
     /// The available rarity tiers.
     /// </summary>
+    /// <remarks>This is not intended to be a localized string, please see Strings for localization.</remarks>
     [JsonProperty(ObjectCreationHandling = ObjectCreationHandling.Replace)]
-    public List<string> RarityTiers { get; set; } = new List<string>
-        {
-            @"None",
-            @"Common",
-            @"Uncommon",
-            @"Rare",
-            @"Epic",
-            @"Legendary",
-        };
+    public List<string> RarityTiers { get; set; } =
+    [
+        @"None",
+        @"Common",
+        @"Uncommon",
+        @"Rare",
+        @"Epic",
+        @"Legendary",
+    ];
+
+    public bool TryGetRarityName(int rarityLevel, [NotNullWhen(true)] out string? rarityName)
+    {
+        rarityName = RarityTiers.Skip(rarityLevel).FirstOrDefault();
+        return rarityName != default;
+    }
 }

Intersect.Client.Core/Interface/Game/DescriptionWindows/ItemDescriptionWindow.cs

@@ -134,9 +134,11 @@ protected void SetupHeader()
         // Set up the item rarity label.
         try
         {
-            var rarityName = Options.Instance.Items.RarityTiers[mItem.Rarity];
-            _ = Strings.ItemDescription.Rarity.TryGetValue(rarityName, out var rarityLabel);
-            header.SetDescription(rarityLabel, rarityColor ?? Color.White);
+            if (Options.Instance.Items.TryGetRarityName(mItem.Rarity, out var rarityName))
+            {
+                _ = Strings.ItemDescription.Rarity.TryGetValue(rarityName, out var rarityLabel);
+                header.SetDescription(rarityLabel, rarityColor ?? Color.White);
+            }
         }
         catch (Exception exception)
         {

Intersect.Client.Core/Localization/Strings.cs

@@ -83,12 +83,12 @@ private static void SynchronizeConfigurableStrings()
             return;
         }
 
-        for (var rarityCode = 0; rarityCode < Options.Instance.Items.RarityTiers.Count; rarityCode++)
+        var keyedRarityTiers = Options.Instance.Items.RarityTiers.Select((rarityName, rarity) => (rarity, rarityName));
+        foreach (var (rarity, rarityName) in keyedRarityTiers)
         {
-            var rarityName = Options.Instance.Items.RarityTiers[rarityCode];
             if (!ItemDescription.Rarity.ContainsKey(rarityName))
             {
-                ItemDescription.Rarity[rarityName] = $"{rarityCode}:{rarityName}";
+                ItemDescription.Rarity[rarityName] = $"{rarity}:{rarityName}";
             }
         }
     }
@@ -1932,7 +1932,7 @@ public partial struct Settings
 
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public static LocalizedString ShowPlayerOverheadInformation = @"Show players overhead information";
-        
+
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public static LocalizedString SimplifiedEscapeMenu = @"Simplified escape menu";
 

Intersect.Editor/Forms/Editors/frmItem.cs

@@ -216,10 +216,10 @@ private void InitLocalization()
         lblBankStackLimit.Text = Strings.ItemEditor.BankStackLimit;
 
         cmbRarity.Items.Clear();
-        for (var i = 0; i < Options.Instance.Items.RarityTiers.Count; i++)
+        var keyedRarityTiers = Options.Instance.Items.RarityTiers.Select((rarityName, rarity) => (rarity, rarityName));
+        foreach (var (rarity, rarityName) in keyedRarityTiers)
         {
-            var rarityName = Options.Instance.Items.RarityTiers[i];
-            cmbRarity.Items.Add(Strings.ItemEditor.rarity[rarityName]);
+            cmbRarity.Items.Add(Strings.ItemEditor.rarity.GetValueOrDefault(rarityName, $"{rarity}:{rarityName}"));
         }
 
         grpEvents.Text = Strings.ItemEditor.EventGroup;
@@ -345,7 +345,7 @@ private void UpdateEditor()
             nudRgbaA.Value = mEditorItem.Color.A;
             cmbEquipmentAnimation.SelectedIndex = AnimationBase.ListIndex(mEditorItem.EquipmentAnimationId) + 1;
             nudPrice.Value = mEditorItem.Price;
-            cmbRarity.SelectedIndex = mEditorItem.Rarity;
+            cmbRarity.Select(mEditorItem.Rarity, 1);
 
             nudStr.Value = mEditorItem.StatsGiven[0];
             nudMag.Value = mEditorItem.StatsGiven[1];
@@ -1529,7 +1529,7 @@ private void cmbEventTriggers_SelectedIndexChanged(object sender, EventArgs e)
         {
             return;
         }
-        
+
         mEditorItem.EventTriggers[SelectedEventTrigger.Value] = EventBase.IdFromList(cmbEventTriggers.SelectedIndex - 1);
 
         PopulateEventTriggerList(lstEventTriggers.SelectedIndex);

Intersect.Editor/Localization/Strings.cs

@@ -494,12 +494,12 @@ private static void SynchronizeConfigurableStrings()
             return;
         }
 
-        for (var rarityCode = 0; rarityCode < Intersect.Options.Instance.Items.RarityTiers.Count; rarityCode++)
+        var keyedRarityTiers = Intersect.Options.Instance.Items.RarityTiers.Select((rarityName, rarity) => (rarity, rarityName));
+        foreach (var (rarity, rarityName) in keyedRarityTiers)
         {
-            var rarityName = Intersect.Options.Instance.Items.RarityTiers[rarityCode];
             if (!ItemEditor.rarity.ContainsKey(rarityName))
             {
-                ItemEditor.rarity[rarityName] = $"{rarityCode}:{rarityName}";
+                ItemEditor.rarity[rarityName] = $"{rarity}:{rarityName}";
             }
         }
     }
@@ -825,7 +825,7 @@ public partial struct AnimationEditor
         public static LocalizedString sound = @"Sound:";
 
         public static LocalizedString soundcomplete = @"Complete Sound Playback After Anim Dies";
-        
+
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public static LocalizedString LoopSoundDuringPreview = @"Loop sound during preview";
 
@@ -1761,7 +1761,7 @@ public partial struct EventChangeSpells
         public static LocalizedString okay = @"Ok";
 
         public static LocalizedString RemoveBound = @"Remove Bound Spell ?";
-        
+
         public static LocalizedString spell = @"Spell: ";
 
         public static LocalizedString title = @"Change Player Spells";
@@ -4678,7 +4678,7 @@ public partial struct Options
 
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public static LocalizedString TextureSize = @"Max Texture Pack Size (Resolution):";
-        
+
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public static LocalizedString CursorSprites = @"Enable cursor sprites for map tools.";
     }