Admin logs (#5419)
* Add admin logging, models, migrations * Add logging damage changes * Add Log admin flag, LogFilter, Logs admin menu tab, message Refactor admin logging API * Change admin log get method names * Fix the name again * Minute amount of reorganization * Reset Postgres db snapshot * Reset Sqlite db snapshot * Make AdminLog have a composite primary key of round, id * Minute cleanup * Change admin system to do a type check instead of index check * Make admin logs use C# 10 interpolated string handlers * Implement UI on its own window Custom controls Searching Add admin log converters * Implement limits into the query * Change logs to be put into an OutputPanel instead for text wrapping * Add log <-> player m2m relationship back * UI improvements, make text wrap, add separators * Remove entity prefix from damaged log * Add explicit m2m model, fix any players filter * Add debug command to test bulk adding logs * Admin logs now just kinda go * Add histogram for database update time * Make admin log system update run every 5 seconds * Add a cap to the log queue and a metric for how many times it has been reached * Add metric for logs sent in a round * Make cvars out of admin logs queue send delay and cap * Merge fixes * Reset some changes * Add test for adding and getting a single log * Add tests for bulk adding logs * Add test for querying logs * Add CallerArgumentExpression to LogStringHandler methods and test * Improve UI, fix SQLite, add searching by round * Add entities to admin logs * Move distinct after orderby * Add migrations * ef core eat my ass * Add cvar for client logs batch size * Sort logs from newest to oldest by default * Merge fixes * Reorganize tests and add one for date ordering * Add note to log types to not change their numeric values * Add impacts to logs, better UI filtering * Make log add callable from shared for convenience * Get current round id directly from game ticker * Revert namespace change for DamageableSystem
This commit is contained in:
Javier Guardia Fernández
committed by
GitHub
GitHub
parent
0f7e81b564
commit
319aec109d
@@ -3,14 +3,18 @@ using System.Collections.Generic;
|
||||
using System.Collections.Immutable;
|
||||
using System.Linq;
|
||||
using System.Net;
|
||||
using System.Text.Json;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Content.Server.Administration.Logs;
|
||||
using Content.Shared.Administration.Logs;
|
||||
using Content.Shared.CharacterAppearance;
|
||||
using Content.Shared.Preferences;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
using Robust.Shared.Enums;
|
||||
using Robust.Shared.Maths;
|
||||
using Robust.Shared.Network;
|
||||
using Robust.Shared.Utility;
|
||||
|
||||
namespace Content.Server.Database
|
||||
{
|
||||
@@ -440,6 +444,54 @@ namespace Content.Server.Database
|
||||
await db.DbContext.SaveChangesAsync(cancel);
|
||||
}
|
||||
|
||||
public virtual async Task<int> AddNewRound(params Guid[] playerIds)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
|
||||
var players = await db.DbContext.Player
|
||||
.Where(player => playerIds.Contains(player.UserId))
|
||||
.ToListAsync();
|
||||
|
||||
var round = new Round
|
||||
{
|
||||
Players = players
|
||||
};
|
||||
|
||||
db.DbContext.Round.Add(round);
|
||||
|
||||
await db.DbContext.SaveChangesAsync();
|
||||
|
||||
return round.Id;
|
||||
}
|
||||
|
||||
public async Task<Round> GetRound(int id)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
|
||||
var round = await db.DbContext.Round
|
||||
.Include(round => round.Players)
|
||||
.SingleAsync(round => round.Id == id);
|
||||
|
||||
return round;
|
||||
}
|
||||
|
||||
public async Task AddRoundPlayers(int id, Guid[] playerIds)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
|
||||
var round = await db.DbContext.Round
|
||||
.Include(round => round.Players)
|
||||
.SingleAsync(round => round.Id == id);
|
||||
|
||||
var players = await db.DbContext.Player
|
||||
.Where(player => playerIds.Contains(player.UserId))
|
||||
.ToListAsync();
|
||||
|
||||
round.Players.AddRange(players);
|
||||
|
||||
await db.DbContext.SaveChangesAsync();
|
||||
}
|
||||
|
||||
public async Task UpdateAdminRankAsync(AdminRank rank, CancellationToken cancel)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
@@ -455,6 +507,160 @@ namespace Content.Server.Database
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Admin Logs
|
||||
|
||||
public virtual async Task AddAdminLogs(List<QueuedLog> logs)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
|
||||
var entities = new Dictionary<int, AdminLogEntity>();
|
||||
|
||||
foreach (var (log, entityData) in logs)
|
||||
{
|
||||
var logEntities = new List<AdminLogEntity>(entityData.Count);
|
||||
foreach (var (id, name) in entityData)
|
||||
{
|
||||
var entity = entities.GetOrNew(id);
|
||||
entity.Name = name;
|
||||
logEntities.Add(entity);
|
||||
}
|
||||
|
||||
log.Entities = logEntities;
|
||||
db.DbContext.AdminLog.Add(log);
|
||||
}
|
||||
|
||||
await db.DbContext.SaveChangesAsync();
|
||||
}
|
||||
|
||||
private async Task<IQueryable<AdminLog>> GetAdminLogsQuery(ServerDbContext db, LogFilter? filter = null)
|
||||
{
|
||||
IQueryable<AdminLog> query = db.AdminLog;
|
||||
|
||||
if (filter == null)
|
||||
{
|
||||
return query.OrderBy(log => log.Date);
|
||||
}
|
||||
|
||||
if (filter.Round != null)
|
||||
{
|
||||
query = query.Where(log => log.RoundId == filter.Round);
|
||||
}
|
||||
|
||||
if (filter.Search != null)
|
||||
{
|
||||
query = query.Where(log => log.Message.Contains(filter.Search));
|
||||
}
|
||||
|
||||
if (filter.Types != null)
|
||||
{
|
||||
query = query.Where(log => filter.Types.Contains(log.Type));
|
||||
}
|
||||
|
||||
if (filter.Impacts != null)
|
||||
{
|
||||
query = query.Where(log => filter.Impacts.Contains(log.Impact));
|
||||
}
|
||||
|
||||
if (filter.Before != null)
|
||||
{
|
||||
query = query.Where(log => log.Date < filter.Before);
|
||||
}
|
||||
|
||||
if (filter.After != null)
|
||||
{
|
||||
query = query.Where(log => log.Date > filter.After);
|
||||
}
|
||||
|
||||
if (filter.AnyPlayers != null)
|
||||
{
|
||||
var players = await db.AdminLogPlayer
|
||||
.Where(player => filter.AnyPlayers.Contains(player.PlayerUserId))
|
||||
.ToListAsync();
|
||||
|
||||
if (players.Count > 0)
|
||||
{
|
||||
query = from log in query
|
||||
join player in db.AdminLogPlayer on log.Id equals player.LogId
|
||||
where filter.AnyPlayers.Contains(player.Player.UserId)
|
||||
select log;
|
||||
}
|
||||
}
|
||||
|
||||
if (filter.AllPlayers != null)
|
||||
{
|
||||
// TODO ADMIN LOGGING
|
||||
}
|
||||
|
||||
query = query.Distinct();
|
||||
|
||||
if (filter.LastLogId != null)
|
||||
{
|
||||
query = filter.DateOrder switch
|
||||
{
|
||||
DateOrder.Ascending => query.Where(log => log.Id < filter.LastLogId),
|
||||
DateOrder.Descending => query.Where(log => log.Id > filter.LastLogId),
|
||||
_ => throw new ArgumentOutOfRangeException(nameof(filter),
|
||||
$"Unknown {nameof(DateOrder)} value {filter.DateOrder}")
|
||||
};
|
||||
}
|
||||
|
||||
query = filter.DateOrder switch
|
||||
{
|
||||
DateOrder.Ascending => query.OrderBy(log => log.Date),
|
||||
DateOrder.Descending => query.OrderByDescending(log => log.Date),
|
||||
_ => throw new ArgumentOutOfRangeException(nameof(filter),
|
||||
$"Unknown {nameof(DateOrder)} value {filter.DateOrder}")
|
||||
};
|
||||
|
||||
if (filter.Limit != null)
|
||||
{
|
||||
query = query.Take(filter.Limit.Value);
|
||||
}
|
||||
|
||||
return query;
|
||||
}
|
||||
|
||||
public async IAsyncEnumerable<string> GetAdminLogMessages(LogFilter? filter = null)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
var query = await GetAdminLogsQuery(db.DbContext, filter);
|
||||
|
||||
await foreach (var log in query.Select(log => log.Message).AsAsyncEnumerable())
|
||||
{
|
||||
yield return log;
|
||||
}
|
||||
}
|
||||
|
||||
public async IAsyncEnumerable<LogRecord> GetAdminLogs(LogFilter? filter = null)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
var query = await GetAdminLogsQuery(db.DbContext, filter);
|
||||
|
||||
await foreach (var log in query.AsAsyncEnumerable())
|
||||
{
|
||||
var players = new Guid[log.Players.Count];
|
||||
for (var i = 0; i < log.Players.Count; i++)
|
||||
{
|
||||
players[i] = log.Players[i].PlayerUserId;
|
||||
}
|
||||
|
||||
yield return new LogRecord(log.Id, log.RoundId, log.Type, log.Impact, log.Date, log.Message, players);
|
||||
}
|
||||
}
|
||||
|
||||
public async IAsyncEnumerable<JsonDocument> GetAdminLogsJson(LogFilter? filter = null)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
var query = await GetAdminLogsQuery(db.DbContext, filter);
|
||||
|
||||
await foreach (var json in query.Select(log => log.Json).AsAsyncEnumerable())
|
||||
{
|
||||
yield return json;
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
protected abstract Task<DbGuard> GetDb();
|
||||
|
||||
protected abstract class DbGuard : IAsyncDisposable
|
||||
|
||||
@@ -3,8 +3,10 @@ using System.Collections.Generic;
|
||||
using System.Collections.Immutable;
|
||||
using System.IO;
|
||||
using System.Net;
|
||||
using System.Text.Json;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Content.Server.Administration.Logs;
|
||||
using Content.Shared.CCVar;
|
||||
using Content.Shared.Preferences;
|
||||
using Microsoft.Data.Sqlite;
|
||||
@@ -17,17 +19,17 @@ using Robust.Shared.IoC;
|
||||
using Robust.Shared.Log;
|
||||
using Robust.Shared.Maths;
|
||||
using Robust.Shared.Network;
|
||||
using Logger = Robust.Shared.Log.Logger;
|
||||
using LogLevel = Robust.Shared.Log.LogLevel;
|
||||
using MSLogLevel = Microsoft.Extensions.Logging.LogLevel;
|
||||
|
||||
|
||||
namespace Content.Server.Database
|
||||
{
|
||||
public interface IServerDbManager
|
||||
{
|
||||
void Init();
|
||||
|
||||
// Preferences
|
||||
#region Preferences
|
||||
Task<PlayerPreferences> InitPrefsAsync(NetUserId userId, ICharacterProfile defaultProfile);
|
||||
Task SaveSelectedCharacterIndexAsync(NetUserId userId, int index);
|
||||
|
||||
@@ -38,12 +40,15 @@ namespace Content.Server.Database
|
||||
// Single method for two operations for transaction.
|
||||
Task DeleteSlotAndSetSelectedIndex(NetUserId userId, int deleteSlot, int newSlot);
|
||||
Task<PlayerPreferences?> GetPlayerPreferencesAsync(NetUserId userId);
|
||||
#endregion
|
||||
|
||||
#region User Ids
|
||||
// Username assignment (for guest accounts, so they persist GUID)
|
||||
Task AssignUserIdAsync(string name, NetUserId userId);
|
||||
Task<NetUserId?> GetAssignedUserIdAsync(string name);
|
||||
#endregion
|
||||
|
||||
// Ban stuff
|
||||
#region Bans
|
||||
/// <summary>
|
||||
/// Looks up a ban by id.
|
||||
/// This will return a pardoned ban as well.
|
||||
@@ -82,8 +87,9 @@ namespace Content.Server.Database
|
||||
|
||||
Task AddServerBanAsync(ServerBanDef serverBan);
|
||||
Task AddServerUnbanAsync(ServerUnbanDef serverBan);
|
||||
#endregion
|
||||
|
||||
// Player records
|
||||
#region Player Records
|
||||
Task UpdatePlayerRecordAsync(
|
||||
NetUserId userId,
|
||||
string userName,
|
||||
@@ -91,15 +97,17 @@ namespace Content.Server.Database
|
||||
ImmutableArray<byte> hwId);
|
||||
Task<PlayerRecord?> GetPlayerRecordByUserName(string userName, CancellationToken cancel = default);
|
||||
Task<PlayerRecord?> GetPlayerRecordByUserId(NetUserId userId, CancellationToken cancel = default);
|
||||
#endregion
|
||||
|
||||
// Connection log
|
||||
#region Connection Logs
|
||||
Task AddConnectionLogAsync(
|
||||
NetUserId userId,
|
||||
string userName,
|
||||
IPAddress address,
|
||||
ImmutableArray<byte> hwId);
|
||||
#endregion
|
||||
|
||||
// Admins
|
||||
#region Admin Ranks
|
||||
Task<Admin?> GetAdminDataForAsync(NetUserId userId, CancellationToken cancel = default);
|
||||
Task<AdminRank?> GetAdminRankAsync(int id, CancellationToken cancel = default);
|
||||
|
||||
@@ -113,6 +121,24 @@ namespace Content.Server.Database
|
||||
Task RemoveAdminRankAsync(int rankId, CancellationToken cancel = default);
|
||||
Task AddAdminRankAsync(AdminRank rank, CancellationToken cancel = default);
|
||||
Task UpdateAdminRankAsync(AdminRank rank, CancellationToken cancel = default);
|
||||
#endregion
|
||||
|
||||
#region Rounds
|
||||
|
||||
Task<int> AddNewRound(params Guid[] playerIds);
|
||||
Task<Round> GetRound(int id);
|
||||
Task AddRoundPlayers(int id, params Guid[] playerIds);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Admin Logs
|
||||
|
||||
Task AddAdminLogs(List<QueuedLog> logs);
|
||||
IAsyncEnumerable<string> GetAdminLogMessages(LogFilter? filter = null);
|
||||
IAsyncEnumerable<LogRecord> GetAdminLogs(LogFilter? filter = null);
|
||||
IAsyncEnumerable<JsonDocument> GetAdminLogsJson(LogFilter? filter = null);
|
||||
|
||||
#endregion
|
||||
}
|
||||
|
||||
public sealed class ServerDbManager : IServerDbManager
|
||||
@@ -290,11 +316,46 @@ namespace Content.Server.Database
|
||||
return _db.AddAdminRankAsync(rank, cancel);
|
||||
}
|
||||
|
||||
public Task<int> AddNewRound(params Guid[] playerIds)
|
||||
{
|
||||
return _db.AddNewRound(playerIds);
|
||||
}
|
||||
|
||||
public Task<Round> GetRound(int id)
|
||||
{
|
||||
return _db.GetRound(id);
|
||||
}
|
||||
|
||||
public Task AddRoundPlayers(int id, params Guid[] playerIds)
|
||||
{
|
||||
return _db.AddRoundPlayers(id, playerIds);
|
||||
}
|
||||
|
||||
public Task UpdateAdminRankAsync(AdminRank rank, CancellationToken cancel = default)
|
||||
{
|
||||
return _db.UpdateAdminRankAsync(rank, cancel);
|
||||
}
|
||||
|
||||
public Task AddAdminLogs(List<QueuedLog> logs)
|
||||
{
|
||||
return _db.AddAdminLogs(logs);
|
||||
}
|
||||
|
||||
public IAsyncEnumerable<string> GetAdminLogMessages(LogFilter? filter = null)
|
||||
{
|
||||
return _db.GetAdminLogMessages(filter);
|
||||
}
|
||||
|
||||
public IAsyncEnumerable<LogRecord> GetAdminLogs(LogFilter? filter = null)
|
||||
{
|
||||
return _db.GetAdminLogs(filter);
|
||||
}
|
||||
|
||||
public IAsyncEnumerable<JsonDocument> GetAdminLogsJson(LogFilter? filter = null)
|
||||
{
|
||||
return _db.GetAdminLogsJson(filter);
|
||||
}
|
||||
|
||||
private DbContextOptions<ServerDbContext> CreatePostgresOptions()
|
||||
{
|
||||
var host = _cfg.GetCVar(CCVars.DatabasePgHost);
|
||||
|
||||
@@ -3,15 +3,19 @@ using System.Collections.Generic;
|
||||
using System.Collections.Immutable;
|
||||
using System.Linq;
|
||||
using System.Net;
|
||||
using System.Text.Json;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Content.Server.Administration.Logs;
|
||||
using Content.Server.IP;
|
||||
using Content.Server.Preferences.Managers;
|
||||
using Content.Shared.Administration.Logs;
|
||||
using Content.Shared.CCVar;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
using Robust.Shared.Configuration;
|
||||
using Robust.Shared.IoC;
|
||||
using Robust.Shared.Network;
|
||||
using Robust.Shared.Utility;
|
||||
|
||||
namespace Content.Server.Database
|
||||
{
|
||||
@@ -246,6 +250,65 @@ namespace Content.Server.Database
|
||||
return (admins.Select(p => (p.a, p.LastSeenUserName)).ToArray(), adminRanks)!;
|
||||
}
|
||||
|
||||
private async Task<int> NextId<TModel>(DbSet<TModel> set, Func<TModel, int> selector) where TModel : class
|
||||
{
|
||||
var id = 1;
|
||||
|
||||
if (await set.AnyAsync())
|
||||
{
|
||||
id = set.Max(selector) + 1;
|
||||
}
|
||||
|
||||
return id;
|
||||
}
|
||||
|
||||
public override async Task<int> AddNewRound(params Guid[] playerIds)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
|
||||
var players = await db.DbContext.Player
|
||||
.Where(player => playerIds.Contains(player.UserId))
|
||||
.ToListAsync();
|
||||
|
||||
var round = new Round
|
||||
{
|
||||
Id = await NextId(db.DbContext.Round, round => round.Id),
|
||||
Players = players
|
||||
};
|
||||
|
||||
db.DbContext.Round.Add(round);
|
||||
|
||||
await db.DbContext.SaveChangesAsync();
|
||||
|
||||
return round.Id;
|
||||
}
|
||||
|
||||
public override async Task AddAdminLogs(List<QueuedLog> logs)
|
||||
{
|
||||
await using var db = await GetDb();
|
||||
|
||||
var nextId = await NextId(db.DbContext.AdminLog, log => log.Id);
|
||||
var entities = new Dictionary<int, AdminLogEntity>();
|
||||
|
||||
foreach (var (log, entityData) in logs)
|
||||
{
|
||||
log.Id = nextId++;
|
||||
|
||||
var logEntities = new List<AdminLogEntity>(entityData.Count);
|
||||
foreach (var (id, name) in entityData)
|
||||
{
|
||||
var entity = entities.GetOrNew(id);
|
||||
entity.Name = name;
|
||||
logEntities.Add(entity);
|
||||
}
|
||||
|
||||
log.Entities = logEntities;
|
||||
db.DbContext.AdminLog.Add(log);
|
||||
}
|
||||
|
||||
await db.DbContext.SaveChangesAsync();
|
||||
}
|
||||
|
||||
private async Task<DbGuardImpl> GetDbImpl()
|
||||
{
|
||||
await _dbReadyTask;
|
||||
|
||||
Reference in New Issue
Block a user