From 8f402ee8ca64165d635efe799235074f3f81653d Mon Sep 17 00:00:00 2001
From: Chief-Engineer <119664036+Chief-Engineer@users.noreply.github.com>
Date: Tue, 28 Feb 2023 10:09:35 -0600
Subject: [PATCH] Add non-players button to log viewer (#14097)

* add include non-players button to log viewer

* breakout player filter check

* fix sending player logs with no players selected

* fix default not returning player logs, causing test issue
---
 .../UI/Logs/AdminLogsControl.xaml             |  2 +
 .../UI/Logs/AdminLogsControl.xaml.cs          | 39 +++++++++++++++++--
 .../Administration/UI/Logs/AdminLogsEui.cs    |  2 +
 .../Logs/AdminLogManager.Cache.cs             | 21 +++++++---
 .../Administration/Logs/AdminLogsEui.cs       |  2 +
 .../Administration/Logs/LogFilter.cs          |  4 ++
 Content.Server/Database/ServerDbBase.cs       | 21 +++++++---
 .../Administration/Logs/AdminLogsEuiState.cs  |  6 +++
 .../en-US/administration/ui/admin-logs.ftl    |  1 +
 9 files changed, 84 insertions(+), 14 deletions(-)

diff --git a/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml b/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml
index 990a7d0803..9d3506c6ba 100644
--- a/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml
+++ b/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml
@@ -32,6 +32,8 @@
                     <BoxContainer Orientation="Vertical" MinWidth="200">
                         <LineEdit Name="PlayerSearch" Access="Public" StyleClasses="actionSearchBox"
                                   HorizontalExpand="true" PlaceHolder="{Loc admin-logs-search-players-placeholder}"/>
+                        <Button Name="IncludeNonPlayersButton" Text="{Loc admin-logs-include-non-player}"
+                                MinWidth="100" StyleClasses="ButtonSquare" ToggleMode="True" />
                         <BoxContainer Orientation="Horizontal">
                             <Button Name="SelectAllPlayersButton" Text="{Loc admin-logs-select-all}"
                                     MinWidth="100" StyleClasses="ButtonSquare" />
diff --git a/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml.cs b/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml.cs
index 35233e4ae3..ce6e8ae278 100644
--- a/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml.cs
+++ b/Content.Client/Administration/UI/Logs/AdminLogsControl.xaml.cs
@@ -34,6 +34,7 @@ public sealed partial class AdminLogsControl : Control
         SelectAllTypesButton.OnPressed += SelectAllTypes;
         SelectNoTypesButton.OnPressed += SelectNoTypes;
 
+        IncludeNonPlayersButton.OnPressed += IncludeNonPlayers;
         SelectAllPlayersButton.OnPressed += SelectAllPlayers;
         SelectNoPlayersButton.OnPressed += SelectNoPlayers;
 
@@ -53,6 +54,7 @@ public sealed partial class AdminLogsControl : Control
     public string Search => LogSearch.Text;
     private int ShownLogs { get; set; }
     private int TotalLogs { get; set; }
+    public bool IncludeNonPlayerLogs { get; set; }
 
     public HashSet<LogType> SelectedTypes { get; } = new();
 
@@ -139,6 +141,13 @@ public sealed partial class AdminLogsControl : Control
         UpdateLogs();
     }
 
+    private void IncludeNonPlayers(ButtonEventArgs args)
+    {
+        IncludeNonPlayerLogs = args.Button.Pressed;
+
+        UpdateLogs();
+    }
+
     private void SelectAllPlayers(ButtonEventArgs args)
     {
         SelectedPlayers.Clear();
@@ -259,12 +268,33 @@ public sealed partial class AdminLogsControl : Control
                button.Text.Contains(PlayerSearch.Text, StringComparison.OrdinalIgnoreCase);
     }
 
+    private bool LogMatchesPlayerFilter(AdminLogLabel label)
+    {
+        if (label.Log.Players.Length == 0)
+            return SelectedPlayers.Count == 0 || IncludeNonPlayerLogs;
+
+        return SelectedPlayers.Overlaps(label.Log.Players);
+    }
+
     private bool ShouldShowLog(AdminLogLabel label)
     {
-        return SelectedTypes.Contains(label.Log.Type) &&
-               (SelectedPlayers.Count + label.Log.Players.Length == 0 || SelectedPlayers.Overlaps(label.Log.Players)) &&
-               SelectedImpacts.Contains(label.Log.Impact) &&
-               label.Log.Message.Contains(LogSearch.Text, StringComparison.OrdinalIgnoreCase);
+        // Check log type
+        if (!SelectedTypes.Contains(label.Log.Type))
+            return false;
+
+        // Check players
+        if (!LogMatchesPlayerFilter(label))
+            return false;
+
+        // Check impact
+        if (!SelectedImpacts.Contains(label.Log.Impact))
+            return false;
+
+        // Check search
+        if (!label.Log.Message.Contains(LogSearch.Text, StringComparison.OrdinalIgnoreCase))
+            return false;
+
+        return true;
     }
 
     private void TypeButtonPressed(ButtonEventArgs args)
@@ -481,6 +511,7 @@ public sealed partial class AdminLogsControl : Control
         SelectAllTypesButton.OnPressed -= SelectAllTypes;
         SelectNoTypesButton.OnPressed -= SelectNoTypes;
 
+        IncludeNonPlayersButton.OnPressed -= IncludeNonPlayers;
         SelectAllPlayersButton.OnPressed -= SelectAllPlayers;
         SelectNoPlayersButton.OnPressed -= SelectNoPlayers;
 
diff --git a/Content.Client/Administration/UI/Logs/AdminLogsEui.cs b/Content.Client/Administration/UI/Logs/AdminLogsEui.cs
index 39faa27284..b5117dc685 100644
--- a/Content.Client/Administration/UI/Logs/AdminLogsEui.cs
+++ b/Content.Client/Administration/UI/Logs/AdminLogsEui.cs
@@ -51,8 +51,10 @@ public sealed class AdminLogsEui : BaseEui
             null,
             null,
             null,
+            LogsControl.SelectedPlayers.Count != 0,
             LogsControl.SelectedPlayers.ToArray(),
             null,
+            LogsControl.IncludeNonPlayerLogs,
             null,
             DateOrder.Descending);
 
diff --git a/Content.Server/Administration/Logs/AdminLogManager.Cache.cs b/Content.Server/Administration/Logs/AdminLogManager.Cache.cs
index d4058b5d16..daa61fbb84 100644
--- a/Content.Server/Administration/Logs/AdminLogManager.Cache.cs
+++ b/Content.Server/Administration/Logs/AdminLogManager.Cache.cs
@@ -122,14 +122,25 @@ public sealed partial class AdminLogManager
             query = query.Where(log => log.Date > filter.After);
         }
 
-        if (filter.AnyPlayers != null)
+        if (filter.IncludePlayers)
         {
-            query = query.Where(log => filter.AnyPlayers.Any(filterPlayer => log.Players.Contains(filterPlayer)));
+            if (filter.AnyPlayers != null)
+            {
+                query = query.Where(log =>
+                    filter.AnyPlayers.Any(filterPlayer => log.Players.Contains(filterPlayer)) ||
+                    log.Players.Length == 0 && filter.IncludeNonPlayers);
+            }
+
+            if (filter.AllPlayers != null)
+            {
+                query = query.Where(log =>
+                    filter.AllPlayers.All(filterPlayer => log.Players.Contains(filterPlayer)) ||
+                    log.Players.Length == 0 && filter.IncludeNonPlayers);
+            }
         }
-
-        if (filter.AllPlayers != null)
+        else
         {
-            query = query.Where(log => filter.AllPlayers.All(filterPlayer => log.Players.Contains(filterPlayer)));
+            query = query.Where(log => log.Players.Length == 0);
         }
 
         if (filter.LogsSent != 0)
diff --git a/Content.Server/Administration/Logs/AdminLogsEui.cs b/Content.Server/Administration/Logs/AdminLogsEui.cs
index 47f6e8af01..7700f02a3b 100644
--- a/Content.Server/Administration/Logs/AdminLogsEui.cs
+++ b/Content.Server/Administration/Logs/AdminLogsEui.cs
@@ -119,8 +119,10 @@ public sealed class AdminLogsEui : BaseEui
                     Impacts = request.Impacts,
                     Before = request.Before,
                     After = request.After,
+                    IncludePlayers = request.IncludePlayers,
                     AnyPlayers = request.AnyPlayers,
                     AllPlayers = request.AllPlayers,
+                    IncludeNonPlayers = request.IncludeNonPlayers,
                     LastLogId = 0,
                     Limit = _clientBatchSize
                 };
diff --git a/Content.Server/Administration/Logs/LogFilter.cs b/Content.Server/Administration/Logs/LogFilter.cs
index 0aa4edadf0..a1ab74c315 100644
--- a/Content.Server/Administration/Logs/LogFilter.cs
+++ b/Content.Server/Administration/Logs/LogFilter.cs
@@ -20,10 +20,14 @@ public sealed class LogFilter
 
     public DateTime? After { get; set; }
 
+    public bool IncludePlayers  { get; set; } = true;
+
     public Guid[]? AnyPlayers { get; set; }
 
     public Guid[]? AllPlayers { get; set; }
 
+    public bool IncludeNonPlayers { get; set; }
+
     public int? LastLogId { get; set; }
 
     public int LogsSent { get; set; }
diff --git a/Content.Server/Database/ServerDbBase.cs b/Content.Server/Database/ServerDbBase.cs
index 9b8616a530..3873659cc4 100644
--- a/Content.Server/Database/ServerDbBase.cs
+++ b/Content.Server/Database/ServerDbBase.cs
@@ -740,14 +740,25 @@ namespace Content.Server.Database
                 query = query.Where(log => log.Date > filter.After);
             }
 
-            if (filter.AnyPlayers != null)
+            if (filter.IncludePlayers)
             {
-                query = query.Where(log => log.Players.Any(p => filter.AnyPlayers.Contains(p.PlayerUserId)));
-            }
+                if (filter.AnyPlayers != null)
+                {
+                    query = query.Where(log =>
+                        log.Players.Any(p => filter.AnyPlayers.Contains(p.PlayerUserId)) ||
+                        log.Players.Count == 0 && filter.IncludeNonPlayers);
+                }
 
-            if (filter.AllPlayers != null)
+                if (filter.AllPlayers != null)
+                {
+                    query = query.Where(log =>
+                        log.Players.All(p => filter.AllPlayers.Contains(p.PlayerUserId)) ||
+                        log.Players.Count == 0 && filter.IncludeNonPlayers);
+                }
+            }
+            else
             {
-                query = query.Where(log => log.Players.All(p => filter.AllPlayers.Contains(p.PlayerUserId)));
+                query = query.Where(log => log.Players.Count == 0);
             }
 
             if (filter.LastLogId != null)
diff --git a/Content.Shared/Administration/Logs/AdminLogsEuiState.cs b/Content.Shared/Administration/Logs/AdminLogsEuiState.cs
index ec3c72c13b..7fb62a9c98 100644
--- a/Content.Shared/Administration/Logs/AdminLogsEuiState.cs
+++ b/Content.Shared/Administration/Logs/AdminLogsEuiState.cs
@@ -67,8 +67,10 @@ public static class AdminLogsEuiMsg
             HashSet<LogImpact>? impacts,
             DateTime? before,
             DateTime? after,
+            bool includePlayers,
             Guid[]? anyPlayers,
             Guid[]? allPlayers,
+            bool includeNonPlayers,
             int? lastLogId,
             DateOrder dateOrder)
         {
@@ -78,8 +80,10 @@ public static class AdminLogsEuiMsg
             Impacts = impacts;
             Before = before;
             After = after;
+            IncludePlayers = includePlayers;
             AnyPlayers = anyPlayers is { Length: > 0 } ? anyPlayers : null;
             AllPlayers = allPlayers is { Length: > 0 } ? allPlayers : null;
+            IncludeNonPlayers = includeNonPlayers;
             LastLogId = lastLogId;
             DateOrder = dateOrder;
         }
@@ -90,8 +94,10 @@ public static class AdminLogsEuiMsg
         public HashSet<LogImpact>? Impacts { get; set; }
         public DateTime? Before { get; set; }
         public DateTime? After { get; set; }
+        public bool IncludePlayers { get; set; }
         public Guid[]? AnyPlayers { get; set; }
         public Guid[]? AllPlayers { get; set; }
+        public bool IncludeNonPlayers { get; set; }
         public int? LastLogId { get; set; }
         public DateOrder DateOrder { get; set; }
     }
diff --git a/Resources/Locale/en-US/administration/ui/admin-logs.ftl b/Resources/Locale/en-US/administration/ui/admin-logs.ftl
index c5787eea0a..457048ff56 100644
--- a/Resources/Locale/en-US/administration/ui/admin-logs.ftl
+++ b/Resources/Locale/en-US/administration/ui/admin-logs.ftl
@@ -15,6 +15,7 @@ admin-logs-select-none = None
 # Players
 admin-logs-search-players-placeholder = Search Players (OR)
 admin-logs-select-none = None
+admin-logs-include-non-player = Include Non-players
 
 # Logs
 admin-logs-search-logs-placeholder = Search Logs
-- 
2.52.0