Add placement logs (#18709)

* add placement logs

* add tile log type

* add support for spawn command

a little janky because the log message isn't entirely accurate when it's the result of a command use

* move method to ActorSystem.cs

* switch to TryGet and outs instead of multiple returns
This commit is contained in:
Chief-Engineer
2023-08-15 00:11:54 -05:00
committed by GitHub
parent be3fc7481e
commit 335e0230f2
4 changed files with 62 additions and 3 deletions

View File

@@ -0,0 +1,58 @@
using Content.Server.Administration.Logs;
using Content.Shared.Database;
using Robust.Server.GameObjects;
using Robust.Shared.Map;
using Robust.Shared.Placement;
namespace Content.Server.Placement;
public sealed class PlacementLoggerSystem : EntitySystem
{
[Dependency] private readonly IAdminLogManager _adminLogger = default!;
[Dependency] private readonly ITileDefinitionManager _tileDefinitionManager = default!;
[Dependency] private readonly ActorSystem _actorSystem = default!;
public override void Initialize()
{
base.Initialize();
SubscribeLocalEvent<PlacementEntityEvent>(OnEntityPlacement);
SubscribeLocalEvent<PlacementTileEvent>(OnTilePlacement);
}
private void OnEntityPlacement(PlacementEntityEvent ev)
{
_actorSystem.TryGetActorFromUserId(ev.PlacerNetUserId, out var actor, out var actorEntity);
var logType = ev.PlacementEventAction switch
{
PlacementEventAction.Create => LogType.EntitySpawn,
PlacementEventAction.Erase => LogType.EntityDelete,
_ => LogType.Action
};
if (actorEntity != null)
_adminLogger.Add(logType, LogImpact.High,
$"{ToPrettyString(actorEntity.Value):actor} used placement system to {ev.PlacementEventAction.ToString().ToLower()} {ToPrettyString(ev.EditedEntity):subject} at {ev.Coordinates}");
else if (actor != null)
_adminLogger.Add(logType, LogImpact.High,
$"{actor:actor} used placement system to {ev.PlacementEventAction.ToString().ToLower()} {ToPrettyString(ev.EditedEntity):subject} at {ev.Coordinates}");
else
_adminLogger.Add(logType, LogImpact.High,
$"Placement system {ev.PlacementEventAction.ToString().ToLower()}ed {ToPrettyString(ev.EditedEntity):subject} at {ev.Coordinates}");
}
private void OnTilePlacement(PlacementTileEvent ev)
{
_actorSystem.TryGetActorFromUserId(ev.PlacerNetUserId, out var actor, out var actorEntity);
if (actorEntity != null)
_adminLogger.Add(LogType.Tile, LogImpact.High,
$"{ToPrettyString(actorEntity.Value):actor} used placement system to set tile {_tileDefinitionManager[ev.TileType].Name} at {ev.Coordinates}");
else if (actor != null)
_adminLogger.Add(LogType.Tile, LogImpact.High,
$"{actor} used placement system to set tile {_tileDefinitionManager[ev.TileType].Name} at {ev.Coordinates}");
else
_adminLogger.Add(LogType.Tile, LogImpact.High,
$"Placement system set tile {_tileDefinitionManager[ev.TileType].Name} at {ev.Coordinates}");
}
}

View File

@@ -42,12 +42,12 @@ public sealed partial class ToolSystem
var center = _turf.GetTileCenter(tile); var center = _turf.GetTileCenter(tile);
if (args.Used != null) if (args.Used != null)
{ {
_adminLogger.Add(LogType.Action, LogImpact.Low, _adminLogger.Add(LogType.Tile, LogImpact.Low,
$"{ToPrettyString(args.User):actor} used {ToPrettyString(args.Used.Value):tool} to pry {_tileDefinitionManager[tile.Tile.TypeId].Name} at {center}"); $"{ToPrettyString(args.User):actor} used {ToPrettyString(args.Used.Value):tool} to pry {_tileDefinitionManager[tile.Tile.TypeId].Name} at {center}");
} }
else else
{ {
_adminLogger.Add(LogType.Action, LogImpact.Low, _adminLogger.Add(LogType.Tile, LogImpact.Low,
$"{ToPrettyString(args.User):actor} pried {_tileDefinitionManager[tile.Tile.TypeId].Name} at {center}"); $"{ToPrettyString(args.User):actor} pried {_tileDefinitionManager[tile.Tile.TypeId].Name} at {center}");
} }

View File

@@ -88,4 +88,5 @@ public enum LogType
Vote = 83, Vote = 83,
ItemConfigure = 84, ItemConfigure = 84,
DeviceLinking = 85, DeviceLinking = 85,
Tile = 86,
} }

View File

@@ -175,7 +175,7 @@ public sealed class FloorTileSystem : EntitySystem
private void PlaceAt(EntityUid user, EntityUid gridUid, MapGridComponent mapGrid, EntityCoordinates location, private void PlaceAt(EntityUid user, EntityUid gridUid, MapGridComponent mapGrid, EntityCoordinates location,
ushort tileId, SoundSpecifier placeSound, float offset = 0) ushort tileId, SoundSpecifier placeSound, float offset = 0)
{ {
_adminLogger.Add(LogType.Action, LogImpact.Low, $"{ToPrettyString(user):actor} placed tile {_tileDefinitionManager[tileId].Name} at {ToPrettyString(gridUid)} {location}"); _adminLogger.Add(LogType.Tile, LogImpact.Low, $"{ToPrettyString(user):actor} placed tile {_tileDefinitionManager[tileId].Name} at {ToPrettyString(gridUid)} {location}");
var variant = ((ContentTileDefinition) _tileDefinitionManager[tileId]).PickVariant(); var variant = ((ContentTileDefinition) _tileDefinitionManager[tileId]).PickVariant();
mapGrid.SetTile(location.Offset(new Vector2(offset, offset)), new Tile(tileId, 0, variant)); mapGrid.SetTile(location.Offset(new Vector2(offset, offset)), new Tile(tileId, 0, variant));