Bwoink System Refactor

Content.Client/Administration/Managers/ClientBwoinkManager.cs

@@ -0,0 +1,213 @@
+using System.Linq;
+using Content.Shared.Administration.Managers.Bwoink;
+using Content.Shared.Administration.Managers.Bwoink.Features;
+using Robust.Client.Audio;
+using Robust.Client.ResourceManagement;
+using Robust.Shared.Audio.Sources;
+using Robust.Shared.Network;
+using Robust.Shared.Player;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Timing;
+
+namespace Content.Client.Administration.Managers;
+
+public sealed class ClientBwoinkManager : SharedBwoinkManager
+{
+    [Dependency] private readonly INetManager _netManager = default!;
+    [Dependency] private readonly ISharedPlayerManager _playerManager = default!;
+    [Dependency] private readonly IResourceCache _res = default!;
+    [Dependency] private readonly IAudioManager _audio = default!;
+    [Dependency] private readonly IClientAdminManager _adminManager = default!;
+    [Dependency] private readonly IGameTiming _gameTiming = default!;
+
+    [ViewVariables]
+    public readonly Dictionary<ProtoId<BwoinkChannelPrototype>, Dictionary<NetUserId, PlayerChannelProperties>>
+        PlayerChannels = new();
+
+    /// <summary>
+    /// Contains the ratelimits for each userchannel we send a typing status to.
+    /// </summary>
+    private Dictionary<NetUserId, TimeSpan> _typingRateLimits = new();
+
+    /// <summary>
+    /// Dictionary that contains the sounds to play for a specified channel, source may be null.
+    /// </summary>
+    public readonly Dictionary<ProtoId<BwoinkChannelPrototype>, IAudioSource?> CachedSounds = new();
+
+    /// <summary>
+    /// Called whenever our prototypes change, or a full state update is applied.
+    /// </summary>
+    public event Action? ReloadedData;
+
+    /// <summary>
+    /// Called whenever we receieve a <see cref="MsgBwoinkTypings"/>
+    /// </summary>
+    public event Action? TypingsUpdated;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+        _netManager.RegisterNetMessage<MsgBwoinkNonAdmin>(BwoinkAttempted);
+        _netManager.RegisterNetMessage<MsgBwoink>(AdminBwoinkAttempted);
+        _netManager.RegisterNetMessage<MsgBwoinkSyncRequest>();
+        _netManager.RegisterNetMessage<MsgBwoinkSync>(SyncBwoinks);
+        _netManager.RegisterNetMessage<MsgBwoinkTypingUpdate>();
+        _netManager.RegisterNetMessage<MsgBwoinkTypings>(SyncTypings);
+
+        _adminManager.AdminStatusUpdated += StatusUpdated;
+    }
+
+    private void SyncTypings(MsgBwoinkTypings message)
+    {
+        TypingStatuses[message.Channel] = message.Typings;
+        TypingsUpdated?.Invoke();
+    }
+
+    private void StatusUpdated()
+    {
+        RequestSync();
+    }
+
+    public PlayerChannelProperties GetOrCreatePlayerPropertiesForChannel(ProtoId<BwoinkChannelPrototype> channel, NetUserId userId)
+    {
+        PlayerChannels.TryAdd(channel, new Dictionary<NetUserId, PlayerChannelProperties>());
+
+        if (PlayerChannels[channel].TryGetValue(userId, out var value))
+            return value;
+
+        PlayerChannels[channel].Add(userId, new PlayerChannelProperties());
+        return PlayerChannels[channel][userId];
+    }
+
+    protected override void UpdatedChannels()
+    {
+        foreach (var (key, channel) in ProtoCache)
+        {
+            foreach (var feature in channel.Features)
+            {
+                if (feature is not SoundOnMessage soundOnMessage)
+                    continue;
+
+                if (CachedSounds.TryGetValue(key, out var cachedSound))
+                    cachedSound?.Dispose();
+
+                var sound = _audio.CreateAudioSource(_res.GetResource<AudioResource>(soundOnMessage.Sound.Path));
+                if (sound != null)
+                    sound.Global = true;
+
+                CachedSounds[key] = sound;
+                break;
+            }
+        }
+
+        ReloadedData?.Invoke();
+    }
+
+    private void SyncBwoinks(MsgBwoinkSync message)
+    {
+        Log.Info($"Received full state! {message.Conversations.Count} channels with {message.Conversations.Values.Select(x => x.Count).Count()} conversations.");
+        Conversations = message.Conversations;
+        ReloadedData?.Invoke();
+    }
+
+    private void AdminBwoinkAttempted(MsgBwoink message)
+    {
+        InvokeMessageReceived(message.Channel,
+            message.Target,
+            message.Message.Content,
+            message.Message.SenderId,
+            message.Message.Sender,
+            message.Message.Flags);
+    }
+
+    private void BwoinkAttempted(MsgBwoinkNonAdmin message)
+    {
+        // This one is targeted to us, so we use our local session as the target.
+        // ReSharper disable once NullableWarningSuppressionIsUsed
+        // "The user Id of the local player. This will be null on the server.".
+        // Null suppression because we will only ever receive this while being connected. If it is null, something has gone wrong.
+        InvokeMessageReceived(message.Channel,
+            _playerManager.LocalUser!.Value,
+            message.Message.Content,
+            message.Message.SenderId,
+            message.Message.Sender,
+            message.Message.Flags);
+    }
+
+    public void SendMessageNonAdmin(ProtoId<BwoinkChannelPrototype> channel, string text)
+    {
+        _netManager.ClientSendMessage(new MsgBwoinkNonAdmin()
+        {
+            // We can leave all of this null since the server will set all of this anyways.
+            Message = new BwoinkMessage(string.Empty, null, DateTime.UtcNow, text, MessageFlags.None),
+            Channel = channel,
+        });
+    }
+
+    public void SendMessageAdmin(BwoinkChannelPrototype channel, NetUserId user, string text)
+    {
+        _netManager.ClientSendMessage(new MsgBwoink()
+        {
+            // We can leave all of this null since the server will set all of this anyways.
+            Message = new BwoinkMessage(string.Empty, null, DateTime.UtcNow, text, MessageFlags.None),
+            Channel = channel,
+            Target = user,
+        });
+    }
+
+    /// <summary>
+    /// Updates your typing status for the client, this results in a <see cref="MsgBwoinkTypingUpdate"/> message.
+    /// </summary>
+    /// <remarks>
+    /// This method has an internal ratelimit of 8 seconds. This ratelimit only applies for setting the typing state to true.
+    /// </remarks>
+    public void SetTypingStatus(ProtoId<BwoinkChannelPrototype> channel, bool typing, NetUserId? userChannel)
+    {
+        const int rateLimit = 3;
+
+        userChannel ??= _playerManager.LocalUser!.Value;
+        // Check ratelimit
+        if (_typingRateLimits.TryGetValue(userChannel.Value, out var limit))
+        {
+            if (typing && _gameTiming.RealTime < limit)
+                return;
+
+            if (!typing)
+            {
+                // We are sending a "stopped typing" message. So: Remove current rate limit key so the next "i am typing" message can get through.
+                _typingRateLimits.Remove(userChannel.Value);
+            }
+            else
+            {
+                _typingRateLimits[userChannel.Value] = _gameTiming.RealTime + TimeSpan.FromSeconds(rateLimit);
+            }
+        }
+        else
+        {
+            _typingRateLimits.Add(userChannel.Value, _gameTiming.RealTime + TimeSpan.FromSeconds(rateLimit));
+        }
+
+        _netManager.ClientSendMessage(new MsgBwoinkTypingUpdate()
+        {
+            IsTyping = typing,
+            Channel = channel,
+            ChannelUserId = userChannel.Value,
+        });
+    }
+
+    /// <summary>
+    /// Requests a full re-sync of all conversations we have. There is no locking so calling this while conversations are on-going may result in dropped or duplicated messages.
+    /// </summary>
+    public void RequestSync()
+    {
+        // TODO: Maybe locking???
+        Log.Info("Resetting Bwoink state!");
+        _netManager.ClientSendMessage(new MsgBwoinkSyncRequest());
+    }
+}
+
+public sealed class PlayerChannelProperties
+{
+    public DateTime LastMessage { get; set; } = DateTime.MinValue;
+    public int Unread { get; set; } = 0;
+}

Content.Client/Administration/UI/Bwoink/BwoinkControl.xaml

@@ -11,18 +11,8 @@
                 </BoxContainer>
             </SplitContainer>
             <BoxContainer Orientation="Horizontal" SetHeight="30" >
-                <CheckBox Name="AdminOnly" Access="Public" Text="{Loc 'admin-ahelp-admin-only'}" ToolTip="{Loc 'admin-ahelp-admin-only-tooltip'}" />
-                <Control HorizontalExpand="True" MinWidth="5" />
-                <CheckBox Name="PlaySound" Access="Public" Text="{Loc 'admin-bwoink-play-sound'}" Pressed="True" />
-                <Control HorizontalExpand="True" MinWidth="5" />
-                <Button Visible="True" Name="PopOut" Access="Public" Text="{Loc 'admin-logs-pop-out'}" StyleClasses="OpenBoth" HorizontalAlignment="Left" />
                 <Control HorizontalExpand="True" />
-                <Button Visible="False" Name="Bans" Text="{Loc 'admin-player-actions-bans'}" StyleClasses="OpenRight" />
-                <Button Visible="False" Name="Notes" Text="{Loc 'admin-player-actions-notes'}" StyleClasses="OpenBoth" />
-                <controls:ConfirmButton Visible="False" Name="Kick" Text="{Loc 'admin-player-actions-kick'}" ConfirmationText="{Loc 'admin-player-actions-confirm'}" StyleClasses="OpenBoth" />
-                <Button Visible="False" Name="Ban" Text="{Loc 'admin-player-actions-ban'}" StyleClasses="OpenBoth" />
-                <controls:ConfirmButton Visible="False" Name="Respawn" Text="{Loc 'admin-player-actions-respawn'}" ConfirmationText="{Loc 'admin-player-actions-confirm'}" StyleClasses="OpenBoth" />
-                <Button Visible="False" Name="Follow" Text="{Loc 'admin-player-actions-follow'}" StyleClasses="OpenLeft" />
+                <Button Visible="False" Name="Playerpanel" Text="{Loc 'admin-player-actions-player-panel'}" />
             </BoxContainer>
         </SplitContainer>
     </PanelContainer>