Vanilla SSS Adapter (#29)

New feature: Vanilla SSS Adapter

Provides for each plugin it's own DefinitionSettings,
players can have individual settings,
LabEx and LabApi SSS compatible.

Author: marchellcx

LabExtended/API/ExPlayer.cs

@@ -1,60 +1,43 @@
-using LabExtended.API.Enums;
-using LabExtended.API.Hints;
+using CentralAuth;
+using CommandSystem;
+using Footprinting;
+using Hints;
+using InventorySystem.Disarming;
+using InventorySystem.Items;
+using InventorySystem.Items.Pickups;
+using LabApi.Features.Wrappers;
 using LabExtended.API.Containers;
 using LabExtended.API.CustomVoice;
-using LabExtended.API.RemoteAdmin;
+using LabExtended.API.Enums;
 using LabExtended.API.FileStorage;
-
-using LabExtended.API.Settings.Menus;
-using LabExtended.API.Settings.Entries;
-
+using LabExtended.API.Hints;
 using LabExtended.API.Hints.Elements.Personal;
-
-using LabExtended.Core.Pooling.Pools;
-
+using LabExtended.API.RemoteAdmin;
+using LabExtended.API.Settings.Entries;
+using LabExtended.API.Settings.Menus;
 using LabExtended.Commands.Attributes;
 using LabExtended.Commands.Interfaces;
-
+using LabExtended.Core;
+using LabExtended.Core.Pooling.Pools;
 using LabExtended.Events;
-using LabExtended.Utilities;
 using LabExtended.Extensions;
-
-using LabApi.Features.Wrappers;
-
+using LabExtended.Utilities;
+using LiteNetLib;
 using Mirror;
 using Mirror.LiteNetLib4Mirror;
-
+using NetworkManagerUtils.Dummies;
+using NorthwoodLib.Pools;
 using PlayerRoles;
-using PlayerRoles.Spectating;
 using PlayerRoles.FirstPersonControl;
-
-using InventorySystem.Disarming;
-
-using InventorySystem.Items;
-using InventorySystem.Items.Pickups;
-
+using PlayerRoles.Spectating;
 using RemoteAdmin;
 using RemoteAdmin.Communication;
-
-using LiteNetLib;
-
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Reflection;
 using UnityEngine;
-
-using VoiceChat;
-
-using Hints;
-
-using CentralAuth;
-
-using CommandSystem;
-
-using Footprinting;
-
-using NetworkManagerUtils.Dummies;
-
-using NorthwoodLib.Pools;
-
 using UserSettings.ServerSpecific;
+using VoiceChat;
 
 #pragma warning disable CS8602 // Dereference of a possibly null reference.
 #pragma warning disable CS8604 // Possible null reference argument.
@@ -135,6 +118,11 @@ public class ExPlayer : Player, IDisposable
         }
     }
 
+    /// <summary>
+    /// Gets a dictionary of Personal DefinedSettings for each Plugin Assembly
+    /// </summary>
+    public Dictionary<Assembly, ServerSpecificSettingBase[]>? SettingsByAssembly => settingsByAssembly;
+
     #region Get
     /// <summary>
     /// Gets an <see cref="ExPlayer"/> instance tied to the specified <see cref="ReferenceHub"/>.
@@ -459,15 +447,17 @@ public static IEnumerable<ExPlayer> Get(RoleTypeId role)
     private string idInfoValue = string.Empty;
 
     internal ICommandRunner? activeRunner;
-    
+
+    internal Dictionary<Assembly, ServerSpecificSettingBase[]>?
+        settingsByAssembly = DictionaryPool<Assembly, ServerSpecificSettingBase[]>.Shared.Rent();
+
     internal Dictionary<string, SettingsMenu>? settingsMenuLookup = DictionaryPool<string, SettingsMenu>.Shared.Rent();
     internal Dictionary<string, SettingsEntry>? settingsIdLookup = DictionaryPool<string, SettingsEntry>.Shared.Rent();
 
     internal Dictionary<int, SettingsEntry>?
         settingsAssignedIdLookup = DictionaryPool<int, SettingsEntry>.Shared.Rent();
 
     internal List<HintElement> removeNextFrame = ListPool<HintElement>.Shared.Rent();
-    internal List<ServerSpecificSettingBase> settingsList = ListPool<ServerSpecificSettingBase>.Shared.Rent();
 
     /// <summary>
     /// Spawns a new dummy player with the specified nickname.
@@ -1443,8 +1433,8 @@ public void Dispose()
             PersistentStorage = null!;
         }
 
-        if (settingsList != null)
-            ListPool<ServerSpecificSettingBase>.Shared.Return(settingsList);
+        if (settingsByAssembly != null)
+            DictionaryPool<Assembly, ServerSpecificSettingBase[]>.Shared.Return(settingsByAssembly);
 
         if (settingsIdLookup != null)
             DictionaryPool<string, SettingsEntry>.Shared.Return(settingsIdLookup);
@@ -1467,7 +1457,7 @@ public void Dispose()
         if (SentPositions != null)
             DictionaryPool<uint, PositionSync.SentPosition>.Shared.Return(SentPositions);
 
-        settingsList = null!;
+        settingsByAssembly = null;
         settingsIdLookup = null;
         settingsMenuLookup = null;
         settingsAssignedIdLookup = null;
@@ -1483,6 +1473,21 @@ public void Dispose()
         Rotation = null!;
     }
 
+    internal void SyncSettingsByAssembly(Assembly assembly, ServerSpecificSettingBase[] collection) {
+        if (!this)
+            return;
+
+        if (settingsByAssembly == null) {
+            ApiLog.Warn($"Player's {nameof(settingsByAssembly)} is null");
+            return;
+        }
+
+        if (collection == null || collection.Length == 0)
+            settingsByAssembly.Remove(assembly);
+        else
+            settingsByAssembly[assembly] = collection;
+    }
+
     private static ReferenceHub SpawnHiddenDummy(string nick)
     {
         var hubGo = UnityEngine.Object.Instantiate(NetworkManager.singleton.playerPrefab);

LabExtended/API/Settings/SettingsManager.cs

@@ -1,21 +1,19 @@
-using LabExtended.Attributes;
-
-using Mirror;
-
-using UserSettings.ServerSpecific;
-
-using LabExtended.API.Settings.Menus;
-using LabExtended.API.Settings.Interfaces;
-
+using LabApi.Loader;
 using LabExtended.API.Settings.Entries;
 using LabExtended.API.Settings.Entries.Buttons;
 using LabExtended.API.Settings.Entries.Dropdown;
-
+using LabExtended.API.Settings.Interfaces;
+using LabExtended.API.Settings.Menus;
+using LabExtended.Attributes;
 using LabExtended.Core;
+using LabExtended.Core.Pooling.Pools;
 using LabExtended.Events;
 using LabExtended.Extensions;
-
+using LabExtended.Patches.Functions.Settings;
+using Mirror;
 using NorthwoodLib.Pools;
+using System.Reflection;
+using UserSettings.ServerSpecific;
 
 #pragma warning disable CS8625 // Cannot convert null literal to non-nullable reference type.
 #pragma warning disable CS8602 // Dereference of a possibly null reference.
@@ -32,6 +30,11 @@ public static class SettingsManager
     /// </summary>
     public static List<SettingsBuilder> AllBuilders { get; } = new();
 
+    /// <summary>
+    /// Gets a dictionary of DefinedSettings for each Plugin Assembly
+    /// </summary>
+    public static Dictionary<Assembly, ServerSpecificSettingBase[]> GlobalSettingsByAssembly { get; } = new();
+
     /// <summary>
     /// Gets or sets the server-side settings version.
     /// </summary>
@@ -48,10 +51,62 @@ public static int Version
     /// <exception cref="ArgumentNullException"></exception>
     public static void SyncEntries(this ExPlayer player)
     {
-        if (player?.ReferenceHub == null)
+        if (player is null)
             throw new ArgumentNullException(nameof(player));
 
-        ServerSpecificSettingsSync.SendToPlayer(player.ReferenceHub);
+        var list = ListPool<ServerSpecificSettingBase>.Shared.Rent();
+        var headers = ListPool<string>.Shared.Rent();
+
+        foreach (var settingsEntry in player.settingsIdLookup)
+        {
+            if (settingsEntry.Value?.Base is null)
+                continue;
+
+            if (!settingsEntry.Value.Player)
+                continue;
+
+            if (settingsEntry.Value.IsHidden)
+                continue;
+
+            if (settingsEntry.Value.Menu != null)
+            {
+                if (settingsEntry.Value.Menu.IsHidden)
+                    continue;
+
+                if (!string.IsNullOrWhiteSpace(settingsEntry.Value.Menu.Header) &&
+                    !headers.Contains(settingsEntry.Value.Menu.CustomId))
+                {
+                    headers.Add(settingsEntry.Value.Menu.CustomId);
+                    list.Add(new SSGroupHeader(settingsEntry.Value.Menu.Header,
+                        settingsEntry.Value.Menu.HeaderReducedPadding, settingsEntry.Value.Menu.HeaderHint));
+                }
+            }
+
+            list.Add(settingsEntry.Value.Base);
+        }
+
+
+        Dictionary<Assembly, ServerSpecificSettingBase[]> playerSettings = DictionaryPool<Assembly, ServerSpecificSettingBase[]>.Shared.Rent();
+        playerSettings.AddRange(GlobalSettingsByAssembly); // todo Use SendOnJoinFilter
+        foreach (var kvp in player.settingsByAssembly) {
+            playerSettings[kvp.Key] = kvp.Value;
+        }
+
+        foreach (var sssByAssemblyEntry in playerSettings) {
+            Assembly pluginAssembly = sssByAssemblyEntry.Key;
+            ServerSpecificSettingBase[] collection = sssByAssemblyEntry.Value;
+            if (collection.First() is not SSGroupHeader) {
+                string pluginName = PluginLoader.Plugins.TryGetFirst(o => o.Value.Equals(pluginAssembly), out var result) ? result.Key.Name : pluginAssembly.GetName().Name;
+                list.Add(new SSGroupHeader(pluginName.SpaceByUpperCase()));
+                collection.ForEach(list.Add);
+            } else if (collection.Length > 1) {
+                collection.ForEach(list.Add);
+            }
+        }
+
+        player.Send(new SSSEntriesPack(ListPool<ServerSpecificSettingBase>.Shared.ToArrayReturn(list), Version));
+
+        ListPool<string>.Shared.Return(headers);
     }
 
     /// <summary>
@@ -434,8 +489,6 @@ public static bool AddMenu(this ExPlayer player, SettingsMenu menu)
             menuHeader.Menu = menu;
             menuHeader.Player = player;
 
-            player.settingsList.Add(menuHeader.Base);
-
             player.settingsIdLookup.Add(menuHeader.CustomId, menuHeader);
             player.settingsAssignedIdLookup.Add(menuHeader.AssignedId, menuHeader);
         }
@@ -449,8 +502,6 @@ public static bool AddMenu(this ExPlayer player, SettingsMenu menu)
                 menuSetting.Player = player;
                 menuSetting.Menu = menu;
 
-                player.settingsList.Add(menuSetting.Base);
-
                 player.settingsIdLookup.Add(menuSetting.CustomId, menuSetting);
                 player.settingsAssignedIdLookup.Add(menuSetting.AssignedId, menuSetting);
 
@@ -491,8 +542,6 @@ public static bool AddSetting(ExPlayer player, SettingsEntry entry)
 
         entry.Player = player;
 
-        player.settingsList.Add(entry.Base);
-
         player.settingsIdLookup.Add(entry.CustomId, entry);
         player.settingsAssignedIdLookup.Add(entry.AssignedId, entry);
 
@@ -526,8 +575,6 @@ public static bool AddSettings(ExPlayer player, IEnumerable<SettingsEntry> entri
         {
             var header = new SettingsGroup(groupHeader, reducedHeaderPadding, headerHint);
 
-            player.settingsList.Add(header.Base);
-
             player.settingsIdLookup[header.CustomId] = header;
             player.settingsAssignedIdLookup[header.AssignedId] = header;
         }
@@ -536,8 +583,6 @@ public static bool AddSettings(ExPlayer player, IEnumerable<SettingsEntry> entri
         {
             entry.Player = player;
 
-            player.settingsList.Add(entry.Base);
-
             player.settingsIdLookup.Add(entry.CustomId, entry);
             player.settingsAssignedIdLookup.Add(entry.AssignedId, entry);
         }
@@ -630,8 +675,6 @@ private static void OnPlayerVerified(ExPlayer player)
 
                             builtSetting.Player = player;
 
-                            player.settingsList.Add(builtSetting.Base);
-
                             player.settingsIdLookup.Add(builtSetting.CustomId, builtSetting);
                             player.settingsAssignedIdLookup.Add(builtSetting.AssignedId, builtSetting);
 
@@ -684,8 +727,6 @@ private static void OnPlayerVerified(ExPlayer player)
                                         continue;
                                     }
 
-                                    player.settingsList.Add(menuSetting.Base);
-
                                     player.settingsIdLookup.Add(menuSetting.CustomId, menuSetting);
                                     player.settingsAssignedIdLookup.Add(menuSetting.AssignedId, menuSetting);
 

…ns/Settings/SettingsHandleStatusPatch.cs …s/Settings/SettingsForwardStatusPatch.csLabExtended/Patches/Functions/Settings/SettingsHandleStatusPatch.cs renamed to LabExtended/Patches/Functions/Settings/SettingsForwardStatusPatch.cs LabExtended/Patches/Functions/Settings/SettingsHandleStatusPatch.cs renamed to LabExtended/Patches/Functions/Settings/SettingsForwardStatusPatch.cs

@@ -8,10 +8,7 @@
 
 namespace LabExtended.Patches.Functions.Settings
 {
-    /// <summary>
-    /// Provides a Harmony patch for handling server-specific settings status messages.
-    /// </summary>
-    public static class SettingsHandleStatusPatch
+    static class SettingsForwardStatusPatch
     {
         [HarmonyPatch(typeof(ServerSpecificSettingsSync), nameof(ServerSpecificSettingsSync.ServerProcessClientStatusMsg))]
         private static bool Prefix(NetworkConnection conn, ref SSSUserStatusReport msg)