Rejig LogStringHandler (#30706)

* Rejig LogStringHandler

* Fix session logs

* Fix properly

* comments

* IAsType support

* Fix mind logs

* Fix mind logging AGAIN

---------

Co-authored-by: PJB3005 <pieterjan.briers+git@gmail.com>
This commit is contained in:
Leon Friedrich
2025-09-06 00:22:49 +12:00
committed by GitHub
parent f45bf4590f
commit 828b1f2044
17 changed files with 413 additions and 198 deletions

View File

@@ -2,9 +2,7 @@
using System.Text.Json; using System.Text.Json;
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
using Content.Server.Administration.Logs.Converters; using Content.Server.Administration.Logs.Converters;
using Robust.Server.GameObjects; using Robust.Shared.Collections;
using Robust.Shared.Map;
using Robust.Shared.Player;
namespace Content.Server.Administration.Logs; namespace Content.Server.Administration.Logs;
@@ -22,55 +20,25 @@ public sealed partial class AdminLogManager
PropertyNamingPolicy = NamingPolicy PropertyNamingPolicy = NamingPolicy
}; };
var interfaces = new ValueList<IAdminLogConverter>();
foreach (var converter in _reflection.FindTypesWithAttribute<AdminLogConverterAttribute>()) foreach (var converter in _reflection.FindTypesWithAttribute<AdminLogConverterAttribute>())
{ {
var instance = _typeFactory.CreateInstance<JsonConverter>(converter); var instance = _typeFactory.CreateInstance<JsonConverter>(converter);
(instance as IAdminLogConverter)?.Init(_dependencies); if (instance is IAdminLogConverter converterInterface)
{
interfaces.Add(converterInterface);
converterInterface.Init(_dependencies);
}
_jsonOptions.Converters.Add(instance); _jsonOptions.Converters.Add(instance);
} }
foreach (var @interface in interfaces)
{
@interface.Init2(_jsonOptions);
}
var converterNames = _jsonOptions.Converters.Select(converter => converter.GetType().Name); var converterNames = _jsonOptions.Converters.Select(converter => converter.GetType().Name);
_sawmill.Debug($"Admin log converters found: {string.Join(" ", converterNames)}"); _sawmill.Debug($"Admin log converters found: {string.Join(" ", converterNames)}");
} }
private (JsonDocument Json, HashSet<Guid> Players) ToJson(
Dictionary<string, object?> properties)
{
var players = new HashSet<Guid>();
var parsed = new Dictionary<string, object?>();
foreach (var key in properties.Keys)
{
var value = properties[key];
value = value switch
{
ICommonSession player => new SerializablePlayer(player),
EntityCoordinates entityCoordinates => new SerializableEntityCoordinates(_entityManager, entityCoordinates),
_ => value
};
var parsedKey = NamingPolicy.ConvertName(key);
parsed.Add(parsedKey, value);
var entityId = properties[key] switch
{
EntityUid id => id,
EntityStringRepresentation rep => rep.Uid,
ICommonSession {AttachedEntity: {Valid: true}} session => session.AttachedEntity,
IComponent component => component.Owner,
_ => null
};
if (_entityManager.TryGetComponent(entityId, out ActorComponent? actor))
{
players.Add(actor.PlayerSession.UserId.UserId);
}
else if (value is SerializablePlayer player)
{
players.Add(player.Player.UserId.UserId);
}
}
return (JsonSerializer.SerializeToDocument(parsed, _jsonOptions), players);
}
} }

View File

@@ -25,7 +25,6 @@ namespace Content.Server.Administration.Logs;
public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogManager public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogManager
{ {
[Dependency] private readonly IConfigurationManager _configuration = default!; [Dependency] private readonly IConfigurationManager _configuration = default!;
[Dependency] private readonly IEntityManager _entityManager = default!;
[Dependency] private readonly ILogManager _logManager = default!; [Dependency] private readonly ILogManager _logManager = default!;
[Dependency] private readonly IServerDbManager _db = default!; [Dependency] private readonly IServerDbManager _db = default!;
[Dependency] private readonly IGameTiming _timing = default!; [Dependency] private readonly IGameTiming _timing = default!;
@@ -72,7 +71,6 @@ public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogMa
// CVars // CVars
private bool _metricsEnabled; private bool _metricsEnabled;
private bool _enabled;
private TimeSpan _queueSendDelay; private TimeSpan _queueSendDelay;
private int _queueMax; private int _queueMax;
private int _preRoundQueueMax; private int _preRoundQueueMax;
@@ -103,7 +101,7 @@ public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogMa
_configuration.OnValueChanged(CVars.MetricsEnabled, _configuration.OnValueChanged(CVars.MetricsEnabled,
value => _metricsEnabled = value, true); value => _metricsEnabled = value, true);
_configuration.OnValueChanged(CCVars.AdminLogsEnabled, _configuration.OnValueChanged(CCVars.AdminLogsEnabled,
value => _enabled = value, true); value => Enabled = value, true);
_configuration.OnValueChanged(CCVars.AdminLogsQueueSendDelay, _configuration.OnValueChanged(CCVars.AdminLogsQueueSendDelay,
value => _queueSendDelay = TimeSpan.FromSeconds(value), true); value => _queueSendDelay = TimeSpan.FromSeconds(value), true);
_configuration.OnValueChanged(CCVars.AdminLogsQueueMax, _configuration.OnValueChanged(CCVars.AdminLogsQueueMax,
@@ -123,6 +121,12 @@ public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogMa
} }
} }
public override string ConvertName(string name)
{
// JsonNamingPolicy is not whitelisted by the sandbox.
return NamingPolicy.ConvertName(name);
}
public async Task Shutdown() public async Task Shutdown()
{ {
if (!_logQueue.IsEmpty) if (!_logQueue.IsEmpty)
@@ -292,8 +296,17 @@ public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogMa
} }
} }
private void Add(LogType type, LogImpact impact, string message, JsonDocument json, HashSet<Guid> players) public override void Add(LogType type, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("")] ref LogStringHandler handler)
{ {
Add(type, LogImpact.Medium, ref handler);
}
public override void Add(LogType type, LogImpact impact, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("")] ref LogStringHandler handler)
{
var message = handler.ToStringAndClear();
if (!Enabled)
return;
var preRound = _runLevel == GameRunLevel.PreRoundLobby; var preRound = _runLevel == GameRunLevel.PreRoundLobby;
var count = preRound ? _preRoundLogQueue.Count : _logQueue.Count; var count = preRound ? _preRoundLogQueue.Count : _logQueue.Count;
if (count >= _dropThreshold) if (count >= _dropThreshold)
@@ -302,6 +315,10 @@ public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogMa
return; return;
} }
var json = JsonSerializer.SerializeToDocument(handler.Values, _jsonOptions);
var id = NextLogId;
var players = GetPlayers(handler.Values, id);
// PostgreSQL does not support storing null chars in text values. // PostgreSQL does not support storing null chars in text values.
if (message.Contains('\0')) if (message.Contains('\0'))
{ {
@@ -311,31 +328,85 @@ public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogMa
var log = new AdminLog var log = new AdminLog
{ {
Id = NextLogId, Id = id,
RoundId = _currentRoundId, RoundId = _currentRoundId,
Type = type, Type = type,
Impact = impact, Impact = impact,
Date = DateTime.UtcNow, Date = DateTime.UtcNow,
Message = message, Message = message,
Json = json, Json = json,
Players = new List<AdminLogPlayer>(players.Count) Players = players,
}; };
var adminLog = false; DoAdminAlerts(players, message, impact);
var adminSys = _entityManager.SystemOrNull<AdminSystem>();
if (preRound)
{
_preRoundLogQueue.Enqueue(log);
}
else
{
_logQueue.Enqueue(log);
CacheLog(log);
}
}
private List<AdminLogPlayer> GetPlayers(Dictionary<string, object?> values, int logId)
{
List<AdminLogPlayer> players = new();
foreach (var value in values.Values)
{
switch (value)
{
case SerializablePlayer player:
AddPlayer(players, player.UserId, logId);
continue;
case EntityStringRepresentation rep:
if (rep.Session is {} session)
AddPlayer(players, session.UserId.UserId, logId);
continue;
case IAdminLogsPlayerValue playerValue:
foreach (var player in playerValue.Players)
{
AddPlayer(players, player, logId);
}
break;
}
}
return players;
}
private void AddPlayer(List<AdminLogPlayer> players, Guid user, int logId)
{
// The majority of logs have a single player, or maybe two. Instead of allocating a List<AdminLogPlayer> and
// HashSet<Guid>, we just iterate over the list to check for duplicates.
foreach (var player in players)
{
if (player.PlayerUserId == user)
return;
}
players.Add(new AdminLogPlayer
{
LogId = logId,
PlayerUserId = user
});
}
private void DoAdminAlerts(List<AdminLogPlayer> players, string message, LogImpact impact)
{
var adminLog = true;
var logMessage = message; var logMessage = message;
foreach (var id in players) foreach (var player in players)
{ {
var player = new AdminLogPlayer var id = player.PlayerUserId;
{
LogId = log.Id,
PlayerUserId = id
};
log.Players.Add(player); if (EntityManager.TrySystem(out AdminSystem? adminSys))
if (adminSys != null)
{ {
var cachedInfo = adminSys.GetCachedPlayerInfo(new NetUserId(id)); var cachedInfo = adminSys.GetCachedPlayerInfo(new NetUserId(id));
if (cachedInfo != null && cachedInfo.Antag) if (cachedInfo != null && cachedInfo.Antag)
@@ -372,35 +443,6 @@ public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogMa
if (adminLog) if (adminLog)
_chat.SendAdminAlert(logMessage); _chat.SendAdminAlert(logMessage);
if (preRound)
{
_preRoundLogQueue.Enqueue(log);
}
else
{
_logQueue.Enqueue(log);
CacheLog(log);
}
}
public override void Add(LogType type, LogImpact impact, ref LogStringHandler handler)
{
if (!_enabled)
{
handler.ToStringAndClear();
return;
}
var (json, players) = ToJson(handler.Values);
var message = handler.ToStringAndClear();
Add(type, impact, message, json, players);
}
public override void Add(LogType type, ref LogStringHandler handler)
{
Add(type, LogImpact.Medium, ref handler);
} }
public async Task<List<SharedAdminLog>> All(LogFilter? filter = null, Func<List<SharedAdminLog>>? listProvider = null) public async Task<List<SharedAdminLog>> All(LogFilter? filter = null, Func<List<SharedAdminLog>>? listProvider = null)

View File

@@ -6,6 +6,13 @@ namespace Content.Server.Administration.Logs.Converters;
public interface IAdminLogConverter public interface IAdminLogConverter
{ {
void Init(IDependencyCollection dependencies); void Init(IDependencyCollection dependencies);
/// <summary>
/// Called after all converters have been added to the <see cref="JsonSerializerOptions"/>.
/// </summary>
void Init2(JsonSerializerOptions options)
{
}
} }
public abstract class AdminLogConverter<T> : JsonConverter<T>, IAdminLogConverter public abstract class AdminLogConverter<T> : JsonConverter<T>, IAdminLogConverter
@@ -14,6 +21,10 @@ public abstract class AdminLogConverter<T> : JsonConverter<T>, IAdminLogConverte
{ {
} }
public virtual void Init2(JsonSerializerOptions options)
{
}
public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{ {
throw new NotSupportedException(); throw new NotSupportedException();

View File

@@ -6,7 +6,7 @@ using Robust.Shared.Map.Components;
namespace Content.Server.Administration.Logs.Converters; namespace Content.Server.Administration.Logs.Converters;
[AdminLogConverter] [AdminLogConverter]
public sealed class EntityCoordinatesConverter : AdminLogConverter<SerializableEntityCoordinates> public sealed class EntityCoordinatesConverter : AdminLogConverter<EntityCoordinates>
{ {
// System.Text.Json actually keeps hold of your JsonSerializerOption instances in a cache on .NET 7. // System.Text.Json actually keeps hold of your JsonSerializerOption instances in a cache on .NET 7.
// Use a weak reference to avoid holding server instances live too long in integration tests. // Use a weak reference to avoid holding server instances live too long in integration tests.
@@ -17,15 +17,16 @@ public sealed class EntityCoordinatesConverter : AdminLogConverter<SerializableE
_entityManager = new WeakReference<IEntityManager>(dependencies.Resolve<IEntityManager>()); _entityManager = new WeakReference<IEntityManager>(dependencies.Resolve<IEntityManager>());
} }
public void Write(Utf8JsonWriter writer, SerializableEntityCoordinates value, JsonSerializerOptions options, IEntityManager entities) public void Write(Utf8JsonWriter writer, EntityCoordinates value, JsonSerializerOptions options, IEntityManager entities)
{ {
writer.WriteStartObject(); writer.WriteStartObject();
WriteEntityInfo(writer, value.EntityUid, entities, "parent"); WriteEntityInfo(writer, value.EntityId, entities, "parent");
writer.WriteNumber("x", value.X); writer.WriteNumber("x", value.X);
writer.WriteNumber("y", value.Y); writer.WriteNumber("y", value.Y);
if (value.MapUid.HasValue) var mapUid = value.GetMapUid(entities);
if (mapUid.HasValue)
{ {
WriteEntityInfo(writer, value.MapUid.Value, entities, "map"); WriteEntityInfo(writer, mapUid.Value, entities, "map");
} }
writer.WriteEndObject(); writer.WriteEndObject();
} }
@@ -33,7 +34,7 @@ public sealed class EntityCoordinatesConverter : AdminLogConverter<SerializableE
private static void WriteEntityInfo(Utf8JsonWriter writer, EntityUid value, IEntityManager entities, string rootName) private static void WriteEntityInfo(Utf8JsonWriter writer, EntityUid value, IEntityManager entities, string rootName)
{ {
writer.WriteStartObject(rootName); writer.WriteStartObject(rootName);
writer.WriteNumber("uid", value.GetHashCode()); writer.WriteNumber("uid", value.Id);
if (entities.TryGetComponent(value, out MetaDataComponent? metaData)) if (entities.TryGetComponent(value, out MetaDataComponent? metaData))
{ {
writer.WriteString("name", metaData.EntityName); writer.WriteString("name", metaData.EntityName);
@@ -51,7 +52,7 @@ public sealed class EntityCoordinatesConverter : AdminLogConverter<SerializableE
writer.WriteEndObject(); writer.WriteEndObject();
} }
public override void Write(Utf8JsonWriter writer, SerializableEntityCoordinates value, JsonSerializerOptions options) public override void Write(Utf8JsonWriter writer, EntityCoordinates value, JsonSerializerOptions options)
{ {
if (!_entityManager.TryGetTarget(out var entityManager)) if (!_entityManager.TryGetTarget(out var entityManager))
throw new InvalidOperationException("EntityManager got garbage collected!"); throw new InvalidOperationException("EntityManager got garbage collected!");
@@ -59,19 +60,3 @@ public sealed class EntityCoordinatesConverter : AdminLogConverter<SerializableE
Write(writer, value, options, entityManager); Write(writer, value, options, entityManager);
} }
} }
public readonly struct SerializableEntityCoordinates
{
public readonly EntityUid EntityUid;
public readonly float X;
public readonly float Y;
public readonly EntityUid? MapUid;
public SerializableEntityCoordinates(IEntityManager entityManager, EntityCoordinates coordinates)
{
EntityUid = coordinates.EntityId;
X = coordinates.X;
Y = coordinates.Y;
MapUid = entityManager.System<SharedTransformSystem>().GetMap(coordinates);
}
}

View File

@@ -1,6 +1,5 @@
using System.Text.Json; using System.Text.Json;
using Content.Server.Administration.Managers; using Content.Server.Administration.Managers;
using Robust.Server.Player;
namespace Content.Server.Administration.Logs.Converters; namespace Content.Server.Administration.Logs.Converters;
@@ -24,7 +23,7 @@ public sealed class EntityStringRepresentationConverter : AdminLogConverter<Enti
{ {
writer.WriteString("player", value.Session.UserId.UserId); writer.WriteString("player", value.Session.UserId.UserId);
if (_adminManager.IsAdmin(value.Uid)) if (_adminManager.IsAdmin(value.Session))
{ {
writer.WriteBoolean("admin", true); writer.WriteBoolean("admin", true);
} }

View File

@@ -0,0 +1,38 @@
using System.Text.Json;
using System.Text.Json.Serialization;
using Content.Shared.Mind;
namespace Content.Server.Administration.Logs.Converters;
[AdminLogConverter]
public sealed class MindStringRepresentationConverter : AdminLogConverter<MindStringRepresentation>
{
private JsonConverter<EntityStringRepresentation> _converter = null!;
public override void Init2(JsonSerializerOptions options)
{
base.Init2(options);
_converter = (JsonConverter<EntityStringRepresentation>)
options.GetConverter(typeof(EntityStringRepresentation));
}
public override void Write(Utf8JsonWriter writer, MindStringRepresentation value, JsonSerializerOptions options)
{
writer.WriteStartObject();
if (value.OwnedEntity is { } owned)
{
writer.WritePropertyName("owned");
_converter.Write(writer, owned, options);
}
if (value.Player is { } player)
{
writer.WriteString("player", player);
writer.WriteBoolean("present", value.PlayerPresent);
}
writer.WriteEndObject();
}
}

View File

@@ -1,45 +1,23 @@
using System.Text.Json; using System.Text.Json;
using Robust.Shared.Player; using Content.Shared.Administration.Logs;
namespace Content.Server.Administration.Logs.Converters; namespace Content.Server.Administration.Logs.Converters;
[AdminLogConverter] [AdminLogConverter]
public sealed class PlayerSessionConverter : AdminLogConverter<SerializablePlayer> public sealed class PlayerSessionConverter : AdminLogConverter<SerializablePlayer>
{ {
// System.Text.Json actually keeps hold of your JsonSerializerOption instances in a cache on .NET 7.
// Use a weak reference to avoid holding server instances live too long in integration tests.
private WeakReference<IEntityManager> _entityManager = default!;
public override void Init(IDependencyCollection dependencies)
{
_entityManager = new WeakReference<IEntityManager>(dependencies.Resolve<IEntityManager>());
}
public override void Write(Utf8JsonWriter writer, SerializablePlayer value, JsonSerializerOptions options) public override void Write(Utf8JsonWriter writer, SerializablePlayer value, JsonSerializerOptions options)
{ {
writer.WriteStartObject(); writer.WriteStartObject();
if (value.Player.AttachedEntity is {Valid: true} playerEntity) if (value.Uid is {Valid: true} playerEntity)
{ {
if (!_entityManager.TryGetTarget(out var entityManager)) writer.WriteNumber("id", playerEntity.Id);
throw new InvalidOperationException("EntityManager got garbage collected!"); writer.WriteString("name", value.Name);
writer.WriteNumber("id", (int) value.Player.AttachedEntity);
writer.WriteString("name", entityManager.GetComponent<MetaDataComponent>(playerEntity).EntityName);
} }
writer.WriteString("player", value.Player.UserId.UserId); writer.WriteString("player", value.UserId);
writer.WriteEndObject(); writer.WriteEndObject();
} }
} }
public readonly struct SerializablePlayer
{
public readonly ICommonSession Player;
public SerializablePlayer(ICommonSession player)
{
Player = player;
}
}

View File

@@ -2,6 +2,7 @@ using Content.Server.Atmos.EntitySystems;
using Content.Server.Botany.Components; using Content.Server.Botany.Components;
using Content.Server.Hands.Systems; using Content.Server.Hands.Systems;
using Content.Server.Popups; using Content.Server.Popups;
using Content.Shared.Administration.Logs;
using Content.Shared.Chemistry.EntitySystems; using Content.Shared.Chemistry.EntitySystems;
using Content.Shared.Atmos; using Content.Shared.Atmos;
using Content.Shared.Botany; using Content.Shared.Botany;
@@ -886,7 +887,7 @@ public sealed class PlantHolderSystem : EntitySystem
foreach (var entry in _solutionContainerSystem.RemoveEachReagent(component.SoilSolution.Value, amt)) foreach (var entry in _solutionContainerSystem.RemoveEachReagent(component.SoilSolution.Value, amt))
{ {
var reagentProto = _prototype.Index<ReagentPrototype>(entry.Reagent.Prototype); var reagentProto = _prototype.Index<ReagentPrototype>(entry.Reagent.Prototype);
reagentProto.ReactionPlant(uid, entry, solution); reagentProto.ReactionPlant(uid, entry, solution, EntityManager, _random, _adminLogger);
} }
} }

View File

@@ -0,0 +1,11 @@
using Robust.Shared.Network;
namespace Content.Shared.Administration.Logs;
/// <summary>
/// Interface implemented by admin log values that contain player references.
/// </summary>
public interface IAdminLogsPlayerValue
{
IEnumerable<NetUserId> Players { get; }
}

View File

@@ -1,10 +1,19 @@
using Content.Shared.Database; using System.Runtime.CompilerServices;
using Content.Shared.Database;
namespace Content.Shared.Administration.Logs; namespace Content.Shared.Administration.Logs;
public interface ISharedAdminLogManager public interface ISharedAdminLogManager
{ {
void Add(LogType type, LogImpact impact, ref LogStringHandler handler); public bool Enabled { get; }
void Add(LogType type, ref LogStringHandler handler); // JsonNamingPolicy is not whitelisted by the sandbox.
public string ConvertName(string name);
// Required for the log string interpolation handler to access ToPrettyString()
public IEntityManager EntityManager { get; }
void Add(LogType type, LogImpact impact, [InterpolatedStringHandlerArgument("")] ref LogStringHandler handler);
void Add(LogType type, [InterpolatedStringHandlerArgument("")] ref LogStringHandler handler);
} }

View File

@@ -1,29 +1,33 @@
using System.Runtime.CompilerServices; using System.Diagnostics.CodeAnalysis;
using System.Runtime.CompilerServices;
using Robust.Shared.Player;
using Robust.Shared.Toolshed.TypeParsers;
namespace Content.Shared.Administration.Logs; namespace Content.Shared.Administration.Logs;
[InterpolatedStringHandler] [InterpolatedStringHandler]
[SuppressMessage("ReSharper", "MethodOverloadWithOptionalParameter")]
public ref struct LogStringHandler public ref struct LogStringHandler
{ {
public readonly ISharedAdminLogManager Logger;
private DefaultInterpolatedStringHandler _handler; private DefaultInterpolatedStringHandler _handler;
public readonly Dictionary<string, object?> Values; public readonly Dictionary<string, object?> Values;
public LogStringHandler(int literalLength, int formattedCount) public LogStringHandler(int literalLength, int formattedCount, ISharedAdminLogManager logger, out bool isEnabled)
{ {
isEnabled = logger.Enabled;
if (!isEnabled)
{
Values = default!;
Logger = default!;
return;
}
_handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount); _handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount);
Values = new Dictionary<string, object?>();
}
public LogStringHandler(int literalLength, int formattedCount, IFormatProvider? provider) // TODO LOGGING Dictionary pool?
{ Values = new Dictionary<string, object?>(formattedCount);
_handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount, provider); Logger = logger;
Values = new Dictionary<string, object?>();
}
public LogStringHandler(int literalLength, int formattedCount, IFormatProvider? provider, Span<char> initialBuffer)
{
_handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount, provider, initialBuffer);
Values = new Dictionary<string, object?>();
} }
private void AddFormat<T>(string? format, T value, string? argument = null) private void AddFormat<T>(string? format, T value, string? argument = null)
@@ -31,15 +35,13 @@ public ref struct LogStringHandler
if (format == null) if (format == null)
{ {
if (argument == null) if (argument == null)
{
return; return;
}
format = argument[0] == '@' ? argument[1..] : argument; format = argument[0] == '@' ? argument[1..] : argument;
} }
if (Values.TryAdd(format, value) || if (Values.TryAdd(Logger.ConvertName(format), value)
Values[format] == (object?) value) || Values[format] is T val && val.Equals(value) )
{ {
return; return;
} }
@@ -48,7 +50,8 @@ public ref struct LogStringHandler
var i = 2; var i = 2;
format = $"{originalFormat}_{i}"; format = $"{originalFormat}_{i}";
while (!Values.TryAdd(format, value)) while (!Values.TryAdd(Logger.ConvertName(format), value)
|| Values[format] is T val2 && val2.Equals(value))
{ {
format = $"{originalFormat}_{i}"; format = $"{originalFormat}_{i}";
i++; i++;
@@ -60,30 +63,176 @@ public ref struct LogStringHandler
_handler.AppendLiteral(value); _handler.AppendLiteral(value);
} }
#region EntityUid
public void AppendFormatted(EntityUid value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(EntityUid value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(EntityUid value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(EntityUid value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
public void AppendFormatted(EntityUid? value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(EntityUid? value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(EntityUid? value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(EntityUid? value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
#endregion
#region NetEntity
public void AppendFormatted(NetEntity value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(NetEntity value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(NetEntity value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(NetEntity value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
public void AppendFormatted(NetEntity? value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(NetEntity? value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(NetEntity? value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(NetEntity? value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
#endregion
#region Player
public void AppendFormatted(ICommonSession? value, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value);
}
public void AppendFormatted(ICommonSession? value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value, format);
}
public void AppendFormatted(ICommonSession? value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value, alignment);
}
public void AppendFormatted(ICommonSession? value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value, alignment, format);
}
#endregion
#region Generic
public void AppendFormatted<T>(T value, [CallerArgumentExpression("value")] string? argument = null) public void AppendFormatted<T>(T value, [CallerArgumentExpression("value")] string? argument = null)
{ {
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), argument);
return;
}
AddFormat(null, value, argument); AddFormat(null, value, argument);
_handler.AppendFormatted(value); _handler.AppendFormatted(value);
} }
public void AppendFormatted<T>(T value, string? format, [CallerArgumentExpression("value")] string? argument = null) public void AppendFormatted<T>(T value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{ {
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), format, argument);
return;
}
AddFormat(format, value, argument); AddFormat(format, value, argument);
_handler.AppendFormatted(value, format); _handler.AppendFormatted(value, format);
} }
public void AppendFormatted<T>(T value, int alignment, [CallerArgumentExpression("value")] string? argument = null) public void AppendFormatted<T>(T value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{ {
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), alignment, argument);
return;
}
AddFormat(null, value, argument); AddFormat(null, value, argument);
_handler.AppendFormatted(value, alignment); _handler.AppendFormatted(value, alignment);
} }
public void AppendFormatted<T>(T value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null) public void AppendFormatted<T>(T value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{ {
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), alignment, format, argument);
return;
}
AddFormat(format, value, argument); AddFormat(format, value, argument);
_handler.AppendFormatted(value, alignment, format); _handler.AppendFormatted(value, alignment, format);
} }
#endregion
public void AppendFormatted(ReadOnlySpan<char> value) public void AppendFormatted(ReadOnlySpan<char> value)
{ {
_handler.AppendFormatted(value); _handler.AppendFormatted(value);
@@ -116,7 +265,23 @@ public ref struct LogStringHandler
public string ToStringAndClear() public string ToStringAndClear()
{ {
Values.Clear();
return _handler.ToStringAndClear(); return _handler.ToStringAndClear();
} }
} }
public readonly struct SerializablePlayer
{
public readonly Guid UserId;
public readonly EntityUid? Uid;
public readonly string? Name;
public SerializablePlayer(ICommonSession player, IEntityManager entityManager)
{
UserId = player.UserId.UserId;
if (player.AttachedEntity is not {} uid)
return;
Uid = uid;
Name = entityManager.GetComponentOrNull<MetaDataComponent>(uid)?.EntityName;
}
}

View File

@@ -5,6 +5,13 @@ namespace Content.Shared.Administration.Logs;
[Virtual] [Virtual]
public class SharedAdminLogManager : ISharedAdminLogManager public class SharedAdminLogManager : ISharedAdminLogManager
{ {
[Dependency] private readonly IEntityManager _entityManager = default!;
public IEntityManager EntityManager => _entityManager;
public bool Enabled { get; protected set; }
public virtual string ConvertName(string name) => name;
public virtual void Add(LogType type, LogImpact impact, ref LogStringHandler handler) public virtual void Add(LogType type, LogImpact impact, ref LogStringHandler handler)
{ {
// noop // noop

View File

@@ -1,16 +0,0 @@
using Content.Shared.Database;
namespace Content.Shared.Administration.Logs;
public abstract class SharedAdminLogSystem : EntitySystem
{
public virtual void Add(LogType type, LogImpact impact, ref LogStringHandler handler)
{
// noop
}
public virtual void Add(LogType type, ref LogStringHandler handler)
{
// noop
}
}

View File

@@ -190,14 +190,17 @@ namespace Content.Shared.Chemistry.Reagent
return removed; return removed;
} }
public void ReactionPlant(EntityUid? plantHolder, ReagentQuantity amount, Solution solution) public void ReactionPlant(EntityUid? plantHolder,
ReagentQuantity amount,
Solution solution,
EntityManager entityManager,
IRobustRandom random,
ISharedAdminLogManager logger)
{ {
if (plantHolder == null) if (plantHolder == null)
return; return;
var entMan = IoCManager.Resolve<IEntityManager>(); var args = new EntityEffectReagentArgs(plantHolder.Value, entityManager, null, solution, amount.Quantity, this, null, 1f);
var random = IoCManager.Resolve<IRobustRandom>();
var args = new EntityEffectReagentArgs(plantHolder.Value, entMan, null, solution, amount.Quantity, this, null, 1f);
foreach (var plantMetabolizable in PlantMetabolisms) foreach (var plantMetabolizable in PlantMetabolisms)
{ {
if (!plantMetabolizable.ShouldApply(args, random)) if (!plantMetabolizable.ShouldApply(args, random))
@@ -206,8 +209,10 @@ namespace Content.Shared.Chemistry.Reagent
if (plantMetabolizable.ShouldLog) if (plantMetabolizable.ShouldLog)
{ {
var entity = args.TargetEntity; var entity = args.TargetEntity;
entMan.System<SharedAdminLogSystem>().Add(LogType.ReagentEffect, plantMetabolizable.LogImpact, logger.Add(
$"Plant metabolism effect {plantMetabolizable.GetType().Name:effect} of reagent {ID:reagent} applied on entity {entMan.ToPrettyString(entity):entity} at {entMan.GetComponent<TransformComponent>(entity).Coordinates:coordinates}"); LogType.ReagentEffect,
plantMetabolizable.LogImpact,
$"Plant metabolism effect {plantMetabolizable.GetType().Name:effect} of reagent {ID} applied on entity {entity}");
} }
plantMetabolizable.Effect(args); plantMetabolizable.Effect(args);

View File

@@ -515,7 +515,7 @@ namespace Content.Shared.Interaction
// all interactions should only happen when in range / unobstructed, so no range check is needed // all interactions should only happen when in range / unobstructed, so no range check is needed
var message = new InteractHandEvent(user, target); var message = new InteractHandEvent(user, target);
RaiseLocalEvent(target, message, true); RaiseLocalEvent(target, message, true);
_adminLogger.Add(LogType.InteractHand, LogImpact.Low, $"{ToPrettyString(user):user} interacted with {ToPrettyString(target):target}"); _adminLogger.Add(LogType.InteractHand, LogImpact.Low, $"{user} interacted with {target}");
DoContactInteraction(user, target, message); DoContactInteraction(user, target, message);
if (message.Handled) if (message.Handled)
return; return;

View File

@@ -608,15 +608,14 @@ public abstract partial class SharedMindSystem : EntitySystem
} }
/// <summary> /// <summary>
/// A string to represent the mind for logging /// A string to represent the mind for logging.
/// </summary> /// </summary>
public string MindOwnerLoggingString(MindComponent mind) public MindStringRepresentation MindOwnerLoggingString(MindComponent mind)
{ {
if (mind.OwnedEntity != null) return new MindStringRepresentation(
return ToPrettyString(mind.OwnedEntity.Value); ToPrettyString(mind.OwnedEntity),
if (mind.UserId != null) mind.UserId != null,
return mind.UserId.Value.ToString(); mind.UserId ?? mind.OriginalOwnerUserId);
return "(originally " + mind.OriginalOwnerUserId + ")";
} }
public string? GetCharacterName(NetUserId userId) public string? GetCharacterName(NetUserId userId)
@@ -733,3 +732,16 @@ public record struct GetCharactedDeadIcEvent(bool? Dead);
/// <param name="Unrevivable"></param> /// <param name="Unrevivable"></param>
[ByRefEvent] [ByRefEvent]
public record struct GetCharacterUnrevivableIcEvent(bool? Unrevivable); public record struct GetCharacterUnrevivableIcEvent(bool? Unrevivable);
public sealed record MindStringRepresentation(EntityStringRepresentation? OwnedEntity, bool PlayerPresent, NetUserId? Player) : IAdminLogsPlayerValue
{
public override string ToString()
{
var str = OwnedEntity?.ToString() ?? "mind without entity";
if (Player != null)
str += $" ({(PlayerPresent ? "" : "originally ")} {Player})";
return str;
}
IEnumerable<NetUserId> IAdminLogsPlayerValue.Players => Player == null ? [] : [Player.Value];
}

View File

@@ -141,7 +141,7 @@ public abstract class SharedObjectivesSystem : EntitySystem
if (ev.Progress != null) if (ev.Progress != null)
return ev.Progress; return ev.Progress;
Log.Error($"Objective {ToPrettyString(uid):objective} of {_mind.MindOwnerLoggingString(mind.Comp)} didn't set a progress value!"); Log.Error($"Objective {ToPrettyString(uid):objective} of {_mind.MindOwnerLoggingString(mind)} didn't set a progress value!");
return null; return null;
} }