using System.Text.Json;
using System.Text.Json.Serialization;
using Content.Server.Administration.Logs.Converters;
-using Robust.Server.GameObjects;
-using Robust.Shared.Map;
-using Robust.Shared.Player;
+using Robust.Shared.Collections;
namespace Content.Server.Administration.Logs;
PropertyNamingPolicy = NamingPolicy
};
+ var interfaces = new ValueList<IAdminLogConverter>();
+
foreach (var converter in _reflection.FindTypesWithAttribute<AdminLogConverterAttribute>())
{
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);
}
- var converterNames = _jsonOptions.Converters.Select(converter => converter.GetType().Name);
- _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)
+ foreach (var @interface in interfaces)
{
- 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);
- }
+ @interface.Init2(_jsonOptions);
}
- return (JsonSerializer.SerializeToDocument(parsed, _jsonOptions), players);
+ var converterNames = _jsonOptions.Converters.Select(converter => converter.GetType().Name);
+ _sawmill.Debug($"Admin log converters found: {string.Join(" ", converterNames)}");
}
}
public sealed partial class AdminLogManager : SharedAdminLogManager, IAdminLogManager
{
[Dependency] private readonly IConfigurationManager _configuration = default!;
- [Dependency] private readonly IEntityManager _entityManager = default!;
[Dependency] private readonly ILogManager _logManager = default!;
[Dependency] private readonly IServerDbManager _db = default!;
[Dependency] private readonly IGameTiming _timing = default!;
// CVars
private bool _metricsEnabled;
- private bool _enabled;
private TimeSpan _queueSendDelay;
private int _queueMax;
private int _preRoundQueueMax;
_configuration.OnValueChanged(CVars.MetricsEnabled,
value => _metricsEnabled = value, true);
_configuration.OnValueChanged(CCVars.AdminLogsEnabled,
- value => _enabled = value, true);
+ value => Enabled = value, true);
_configuration.OnValueChanged(CCVars.AdminLogsQueueSendDelay,
value => _queueSendDelay = TimeSpan.FromSeconds(value), true);
_configuration.OnValueChanged(CCVars.AdminLogsQueueMax,
}
}
+ public override string ConvertName(string name)
+ {
+ // JsonNamingPolicy is not whitelisted by the sandbox.
+ return NamingPolicy.ConvertName(name);
+ }
+
public async Task Shutdown()
{
if (!_logQueue.IsEmpty)
}
}
- 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 count = preRound ? _preRoundLogQueue.Count : _logQueue.Count;
if (count >= _dropThreshold)
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.
if (message.Contains('\0'))
{
var log = new AdminLog
{
- Id = NextLogId,
+ Id = id,
RoundId = _currentRoundId,
Type = type,
Impact = impact,
Date = DateTime.UtcNow,
Message = message,
Json = json,
- Players = new List<AdminLogPlayer>(players.Count)
+ Players = players,
};
- var adminLog = false;
- var adminSys = _entityManager.SystemOrNull<AdminSystem>();
- var logMessage = message;
+ DoAdminAlerts(players, message, impact);
- foreach (var id in players)
+ if (preRound)
{
- var player = new AdminLogPlayer
+ _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)
{
- LogId = log.Id,
- PlayerUserId = id
- };
+ case SerializablePlayer player:
+ AddPlayer(players, player.UserId, logId);
+ continue;
+
+ case EntityStringRepresentation rep:
+ if (rep.Session is {} session)
+ AddPlayer(players, session.UserId.UserId, logId);
+ continue;
- log.Players.Add(player);
+ case IAdminLogsPlayerValue playerValue:
+ foreach (var player in playerValue.Players)
+ {
+ AddPlayer(players, player, logId);
+ }
- if (adminSys != null)
+ 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;
+
+ foreach (var player in players)
+ {
+ var id = player.PlayerUserId;
+
+ if (EntityManager.TrySystem(out AdminSystem? adminSys))
{
var cachedInfo = adminSys.GetCachedPlayerInfo(new NetUserId(id));
if (cachedInfo != null && cachedInfo.Antag)
if (adminLog)
_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 interface IAdminLogConverter
{
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 virtual void Init2(JsonSerializerOptions options)
+ {
+ }
+
public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
throw new NotSupportedException();
namespace Content.Server.Administration.Logs.Converters;
[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.
// Use a weak reference to avoid holding server instances live too long in integration tests.
_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();
- WriteEntityInfo(writer, value.EntityUid, entities, "parent");
+ WriteEntityInfo(writer, value.EntityId, entities, "parent");
writer.WriteNumber("x", value.X);
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();
}
private static void WriteEntityInfo(Utf8JsonWriter writer, EntityUid value, IEntityManager entities, string rootName)
{
writer.WriteStartObject(rootName);
- writer.WriteNumber("uid", value.GetHashCode());
+ writer.WriteNumber("uid", value.Id);
if (entities.TryGetComponent(value, out MetaDataComponent? metaData))
{
writer.WriteString("name", metaData.EntityName);
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))
throw new InvalidOperationException("EntityManager got garbage collected!");
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);
- }
-}
using System.Text.Json;
using Content.Server.Administration.Managers;
-using Robust.Server.Player;
namespace Content.Server.Administration.Logs.Converters;
{
writer.WriteString("player", value.Session.UserId.UserId);
- if (_adminManager.IsAdmin(value.Uid))
+ if (_adminManager.IsAdmin(value.Session))
{
writer.WriteBoolean("admin", true);
}
--- /dev/null
+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();
+ }
+}
using System.Text.Json;
-using Robust.Shared.Player;
+using Content.Shared.Administration.Logs;
namespace Content.Server.Administration.Logs.Converters;
[AdminLogConverter]
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)
{
writer.WriteStartObject();
- if (value.Player.AttachedEntity is {Valid: true} playerEntity)
+ if (value.Uid is {Valid: true} playerEntity)
{
- if (!_entityManager.TryGetTarget(out var entityManager))
- throw new InvalidOperationException("EntityManager got garbage collected!");
-
- writer.WriteNumber("id", (int) value.Player.AttachedEntity);
- writer.WriteString("name", entityManager.GetComponent<MetaDataComponent>(playerEntity).EntityName);
+ writer.WriteNumber("id", playerEntity.Id);
+ writer.WriteString("name", value.Name);
}
- writer.WriteString("player", value.Player.UserId.UserId);
+ writer.WriteString("player", value.UserId);
writer.WriteEndObject();
}
}
-
-public readonly struct SerializablePlayer
-{
- public readonly ICommonSession Player;
-
- public SerializablePlayer(ICommonSession player)
- {
- Player = player;
- }
-}
using Content.Server.Botany.Components;
using Content.Server.Hands.Systems;
using Content.Server.Popups;
+using Content.Shared.Administration.Logs;
using Content.Shared.Chemistry.EntitySystems;
using Content.Shared.Atmos;
using Content.Shared.Botany;
foreach (var entry in _solutionContainerSystem.RemoveEachReagent(component.SoilSolution.Value, amt))
{
var reagentProto = _prototype.Index<ReagentPrototype>(entry.Reagent.Prototype);
- reagentProto.ReactionPlant(uid, entry, solution);
+ reagentProto.ReactionPlant(uid, entry, solution, EntityManager, _random, _adminLogger);
}
}
--- /dev/null
+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; }
+}
-using Content.Shared.Database;
+using System.Runtime.CompilerServices;
+using Content.Shared.Database;
namespace Content.Shared.Administration.Logs;
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);
}
-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;
[InterpolatedStringHandler]
+[SuppressMessage("ReSharper", "MethodOverloadWithOptionalParameter")]
public ref struct LogStringHandler
{
+ public readonly ISharedAdminLogManager Logger;
private DefaultInterpolatedStringHandler _handler;
public readonly Dictionary<string, object?> Values;
- public LogStringHandler(int literalLength, int formattedCount)
+ public LogStringHandler(int literalLength, int formattedCount, ISharedAdminLogManager logger, out bool isEnabled)
{
- _handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount);
- Values = new Dictionary<string, object?>();
- }
+ isEnabled = logger.Enabled;
+ if (!isEnabled)
+ {
+ Values = default!;
+ Logger = default!;
+ return;
+ }
- public LogStringHandler(int literalLength, int formattedCount, IFormatProvider? provider)
- {
- _handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount, provider);
- Values = new Dictionary<string, object?>();
- }
+ _handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount);
- public LogStringHandler(int literalLength, int formattedCount, IFormatProvider? provider, Span<char> initialBuffer)
- {
- _handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount, provider, initialBuffer);
- Values = new Dictionary<string, object?>();
+ // TODO LOGGING Dictionary pool?
+ Values = new Dictionary<string, object?>(formattedCount);
+ Logger = logger;
}
private void AddFormat<T>(string? format, T value, string? argument = null)
if (format == null)
{
if (argument == null)
- {
return;
- }
format = argument[0] == '@' ? argument[1..] : argument;
}
- if (Values.TryAdd(format, value) ||
- Values[format] == (object?) value)
+ if (Values.TryAdd(Logger.ConvertName(format), value)
+ || Values[format] is T val && val.Equals(value) )
{
return;
}
var i = 2;
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}";
i++;
_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)
{
+ if (value is IAsType<EntityUid> ent)
+ {
+ AppendFormatted(ent.AsType(), argument);
+ return;
+ }
+
AddFormat(null, value, argument);
_handler.AppendFormatted(value);
}
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);
_handler.AppendFormatted(value, format);
}
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);
_handler.AppendFormatted(value, alignment);
}
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);
_handler.AppendFormatted(value, alignment, format);
}
+ #endregion
+
public void AppendFormatted(ReadOnlySpan<char> value)
{
_handler.AppendFormatted(value);
public string ToStringAndClear()
{
- Values.Clear();
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;
+ }
+}
[Virtual]
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)
{
// noop
+++ /dev/null
-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
- }
-}
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)
return;
- var entMan = IoCManager.Resolve<IEntityManager>();
- var random = IoCManager.Resolve<IRobustRandom>();
- var args = new EntityEffectReagentArgs(plantHolder.Value, entMan, null, solution, amount.Quantity, this, null, 1f);
+ var args = new EntityEffectReagentArgs(plantHolder.Value, entityManager, null, solution, amount.Quantity, this, null, 1f);
foreach (var plantMetabolizable in PlantMetabolisms)
{
if (!plantMetabolizable.ShouldApply(args, random))
if (plantMetabolizable.ShouldLog)
{
var entity = args.TargetEntity;
- entMan.System<SharedAdminLogSystem>().Add(LogType.ReagentEffect, plantMetabolizable.LogImpact,
- $"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}");
+ logger.Add(
+ LogType.ReagentEffect,
+ plantMetabolizable.LogImpact,
+ $"Plant metabolism effect {plantMetabolizable.GetType().Name:effect} of reagent {ID} applied on entity {entity}");
}
plantMetabolizable.Effect(args);
// all interactions should only happen when in range / unobstructed, so no range check is needed
var message = new InteractHandEvent(user, target);
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);
if (message.Handled)
return;
}
/// <summary>
- /// A string to represent the mind for logging
+ /// A string to represent the mind for logging.
/// </summary>
- public string MindOwnerLoggingString(MindComponent mind)
+ public MindStringRepresentation MindOwnerLoggingString(MindComponent mind)
{
- if (mind.OwnedEntity != null)
- return ToPrettyString(mind.OwnedEntity.Value);
- if (mind.UserId != null)
- return mind.UserId.Value.ToString();
- return "(originally " + mind.OriginalOwnerUserId + ")";
+ return new MindStringRepresentation(
+ ToPrettyString(mind.OwnedEntity),
+ mind.UserId != null,
+ mind.UserId ?? mind.OriginalOwnerUserId);
}
public string? GetCharacterName(NetUserId userId)
/// <param name="Unrevivable"></param>
[ByRefEvent]
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];
+}
if (ev.Progress != null)
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;
}