tommy/tbd-station-14
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove devices from device lists when they get deleted (#16783)

Browse Source 
* Implement device network device shutdown subscribtion
Implement removing devices from device lists when they get deleted

* Improve name and doc comment for DeviceShutDownEvent

* Change ShutdownSubscriber data field tag

* Change UpdateRemovalSubscription name to UpdateShutdownSubscription
This commit is contained in:
Julian Giebel
2023-05-26 00:08:22 +02:00
committed by GitHub
parent a02753545d
commit 2bb1fde4dc
8 changed files with 157 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
Content.Server/DeviceNetwork/Systems/DeviceListSystem.cs
View File

@@ -2,6 +2,7 @@
using Content.Server.DeviceNetwork.Components;
using Content.Shared.DeviceNetwork;
using Content.Shared.DeviceNetwork.Components;
using Content.Shared.DeviceNetwork.Systems;
using Content.Shared.Interaction;
using JetBrains.Annotations;
using Robust.Shared.Map.Events;
@@ -13,16 +14,104 @@ public sealed class DeviceListSystem : SharedDeviceListSystem
{
private ISawmill _sawmill = default!;
[Dependency] private DeviceNetworkSystem _deviceNetworkSystem = null!;
public override void Initialize()
{
base.Initialize();
SubscribeLocalEvent<DeviceListComponent, ComponentInit>(OnInit);
SubscribeLocalEvent<DeviceListComponent, BeforeBroadcastAttemptEvent>(OnBeforeBroadcast);
SubscribeLocalEvent<DeviceListComponent, BeforePacketSentEvent>(OnBeforePacketSent);
SubscribeLocalEvent<DeviceListComponent, DeviceShutDownEvent>(OnDeviceShutdown);
SubscribeLocalEvent<BeforeSaveEvent>(OnMapSave);
_sawmill = Logger.GetSawmill("devicelist");
}
public void OnInit(EntityUid uid, DeviceListComponent component, ComponentInit args)
{
Dirty(component);
}
/// <summary>
/// Gets the given device list as a dictionary
/// </summary>
/// <remarks>
/// If any entity in the device list is pre-map init, it will show the entity UID of the device instead.
/// </remarks>
public Dictionary<string, EntityUid> GetDeviceList(EntityUid uid, DeviceListComponent? deviceList = null)
{
if (!Resolve(uid, ref deviceList))
return new Dictionary<string, EntityUid>();
var devices = new Dictionary<string, EntityUid>(deviceList.Devices.Count);
foreach (var deviceUid in deviceList.Devices)
{
if (!TryComp(deviceUid, out DeviceNetworkComponent? deviceNet))
continue;
var address = MetaData(deviceUid).EntityLifeStage == EntityLifeStage.MapInitialized
? deviceNet.Address
: $"UID: {deviceUid.ToString()}";
devices.Add(address, deviceUid);
}
return devices;
}
protected override void UpdateShutdownSubscription(EntityUid uid, List<EntityUid> newDevices, List<EntityUid> oldDevices)
{
foreach (var device in newDevices)
{
_deviceNetworkSystem.SubscribeToDeviceShutdown(uid, device);
}
var removedDevices = oldDevices.Except(newDevices);
foreach (var device in removedDevices)
{
_deviceNetworkSystem.UnsubscribeFromDeviceShutdown(uid, device);
}
}
/// <summary>
/// Filters the broadcasts recipient list against the device list as either an allow or deny list depending on the components IsAllowList field
/// </summary>
private void OnBeforeBroadcast(EntityUid uid, DeviceListComponent component, BeforeBroadcastAttemptEvent args)
{
//Don't filter anything if the device list is empty
if (component.Devices.Count == 0)
{
if (component.IsAllowList) args.Cancel();
return;
}
HashSet<DeviceNetworkComponent> filteredRecipients = new(args.Recipients.Count);
foreach (var recipient in args.Recipients)
{
if (component.Devices.Contains(recipient.Owner) == component.IsAllowList) filteredRecipients.Add(recipient);
}
args.ModifiedRecipients = filteredRecipients;
}
/// <summary>
/// Filters incoming packets if that is enabled <see cref="OnBeforeBroadcast"/>
/// </summary>
private void OnBeforePacketSent(EntityUid uid, DeviceListComponent component, BeforePacketSentEvent args)
{
if (component.HandleIncomingPackets && component.Devices.Contains(args.Sender) != component.IsAllowList)
args.Cancel();
}
private void OnDeviceShutdown(EntityUid uid, DeviceListComponent component, ref DeviceShutDownEvent args)
{
component.Devices.Remove(args.ShutDownEntityUid);
Dirty(component);
}
private void OnMapSave(BeforeSaveEvent ev)
{
List<EntityUid> toRemove = new();
@@ -64,69 +153,4 @@ public sealed class DeviceListSystem : SharedDeviceListSystem
toRemove.Clear();
}
}
public void OnInit(EntityUid uid, DeviceListComponent component, ComponentInit args)
{
Dirty(component);
}
/// <summary>
/// Gets the given device list as a dictionary
/// </summary>
/// <remarks>
/// If any entity in the device list is pre-map init, it will show the entity UID of the device instead.
/// </remarks>
public Dictionary<string, EntityUid> GetDeviceList(EntityUid uid, DeviceListComponent? deviceList = null)
{
if (!Resolve(uid, ref deviceList))
return new Dictionary<string, EntityUid>();
var devices = new Dictionary<string, EntityUid>(deviceList.Devices.Count);
foreach (var deviceUid in deviceList.Devices)
{
if (!TryComp(deviceUid, out DeviceNetworkComponent? deviceNet))
continue;
var address = MetaData(deviceUid).EntityLifeStage == EntityLifeStage.MapInitialized
? deviceNet.Address
: $"UID: {deviceUid.ToString()}";
devices.Add(address, deviceUid);
}
return devices;
}
/// <summary>
/// Filters the broadcasts recipient list against the device list as either an allow or deny list depending on the components IsAllowList field
/// </summary>
private void OnBeforeBroadcast(EntityUid uid, DeviceListComponent component, BeforeBroadcastAttemptEvent args)
{
//Don't filter anything if the device list is empty
if (component.Devices.Count == 0)
{
if (component.IsAllowList) args.Cancel();
return;
}
HashSet<DeviceNetworkComponent> filteredRecipients = new(args.Recipients.Count);
foreach (var recipient in args.Recipients)
{
if (component.Devices.Contains(recipient.Owner) == component.IsAllowList) filteredRecipients.Add(recipient);
}
args.ModifiedRecipients = filteredRecipients;
}
/// <summary>
/// Filters incoming packets if that is enabled <see cref="OnBeforeBroadcast"/>
/// </summary>
private void OnBeforePacketSent(EntityUid uid, DeviceListComponent component, BeforePacketSentEvent args)
{
if (component.HandleIncomingPackets && component.Devices.Contains(args.Sender) != component.IsAllowList)
args.Cancel();
}
}