* Fix usages of TryIndex()
Most usages of TryIndex() were using it incorrectly. Checking whether prototype IDs specified in prototypes actually existed before using them. This is not appropriate as it's just hiding bugs that should be getting caught by the YAML linter and other tools. (#39115)
This then resulted in TryIndex() getting modified to log errors (94f98073b0), which is incorrect as it causes false-positive errors in proper uses of the API: external data validation. (#39098)
This commit goes through and checks every call site of TryIndex() to see whether they were correct. Most call sites were replaced with the new Resolve(), which is suitable for these "defensive programming" use cases.
Fixes #39115
Breaking change: while doing this I noticed IdCardComponent and related systems were erroneously using ProtoId<AccessLevelPrototype> for job prototypes. This has been corrected.
* fix tests
---------
Co-authored-by: slarticodefast <161409025+slarticodefast@users.noreply.github.com>
266 lines
9.3 KiB
C#
266 lines
9.3 KiB
C#
using Content.Server.DeviceNetwork.Systems;
|
|
using Content.Shared.ActionBlocker;
|
|
using Content.Shared.DeviceNetwork;
|
|
using Content.Shared.DeviceNetwork.Events;
|
|
using Content.Shared.Power;
|
|
using Content.Shared.SurveillanceCamera;
|
|
using Content.Shared.Verbs;
|
|
using Robust.Server.GameObjects;
|
|
using Robust.Shared.Prototypes;
|
|
using Content.Shared.DeviceNetwork.Components;
|
|
|
|
namespace Content.Server.SurveillanceCamera;
|
|
|
|
public sealed class SurveillanceCameraRouterSystem : EntitySystem
|
|
{
|
|
[Dependency] private readonly DeviceNetworkSystem _deviceNetworkSystem = default!;
|
|
[Dependency] private readonly ActionBlockerSystem _actionBlocker = default!;
|
|
[Dependency] private readonly IPrototypeManager _prototypeManager = default!;
|
|
[Dependency] private readonly UserInterfaceSystem _userInterface = default!;
|
|
public override void Initialize()
|
|
{
|
|
SubscribeLocalEvent<SurveillanceCameraRouterComponent, ComponentInit>(OnInitialize);
|
|
SubscribeLocalEvent<SurveillanceCameraRouterComponent, DeviceNetworkPacketEvent>(OnPacketReceive);
|
|
SubscribeLocalEvent<SurveillanceCameraRouterComponent, SurveillanceCameraSetupSetNetwork>(OnSetNetwork);
|
|
SubscribeLocalEvent<SurveillanceCameraRouterComponent, GetVerbsEvent<AlternativeVerb>>(AddVerbs);
|
|
SubscribeLocalEvent<SurveillanceCameraRouterComponent, PowerChangedEvent>(OnPowerChanged);
|
|
}
|
|
|
|
private void OnInitialize(EntityUid uid, SurveillanceCameraRouterComponent router, ComponentInit args)
|
|
{
|
|
if (router.SubnetFrequencyId == null ||
|
|
!_prototypeManager.TryIndex(router.SubnetFrequencyId, out DeviceFrequencyPrototype? subnetFrequency))
|
|
{
|
|
return;
|
|
}
|
|
|
|
router.SubnetFrequency = subnetFrequency.Frequency;
|
|
router.Active = true;
|
|
}
|
|
|
|
private void OnPacketReceive(EntityUid uid, SurveillanceCameraRouterComponent router, DeviceNetworkPacketEvent args)
|
|
{
|
|
if (!router.Active
|
|
|| string.IsNullOrEmpty(args.SenderAddress)
|
|
|| !args.Data.TryGetValue(DeviceNetworkConstants.Command, out string? command))
|
|
{
|
|
return;
|
|
}
|
|
|
|
switch (command)
|
|
{
|
|
case SurveillanceCameraSystem.CameraConnectMessage:
|
|
if (!args.Data.TryGetValue(SurveillanceCameraSystem.CameraAddressData, out string? address))
|
|
{
|
|
return;
|
|
}
|
|
|
|
ConnectCamera(uid, args.SenderAddress, address, router);
|
|
break;
|
|
case SurveillanceCameraSystem.CameraHeartbeatMessage:
|
|
if (!args.Data.TryGetValue(SurveillanceCameraSystem.CameraAddressData, out string? camera))
|
|
{
|
|
return;
|
|
}
|
|
|
|
SendHeartbeat(uid, args.SenderAddress, camera, router);
|
|
break;
|
|
case SurveillanceCameraSystem.CameraSubnetConnectMessage:
|
|
AddMonitorToRoute(uid, args.SenderAddress, router);
|
|
PingSubnet(uid, router);
|
|
break;
|
|
case SurveillanceCameraSystem.CameraSubnetDisconnectMessage:
|
|
RemoveMonitorFromRoute(uid, args.SenderAddress, router);
|
|
break;
|
|
case SurveillanceCameraSystem.CameraPingSubnetMessage:
|
|
PingSubnet(uid, router);
|
|
break;
|
|
case SurveillanceCameraSystem.CameraPingMessage:
|
|
SubnetPingResponse(uid, args.SenderAddress, router);
|
|
break;
|
|
case SurveillanceCameraSystem.CameraDataMessage:
|
|
SendCameraInfo(uid, args.Data, router);
|
|
break;
|
|
}
|
|
}
|
|
|
|
private void OnPowerChanged(EntityUid uid, SurveillanceCameraRouterComponent component, ref PowerChangedEvent args)
|
|
{
|
|
component.MonitorRoutes.Clear();
|
|
component.Active = args.Powered;
|
|
}
|
|
|
|
private void AddVerbs(EntityUid uid, SurveillanceCameraRouterComponent component, GetVerbsEvent<AlternativeVerb> verbs)
|
|
{
|
|
if (!_actionBlocker.CanInteract(verbs.User, uid) || !_actionBlocker.CanComplexInteract(verbs.User))
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (component.SubnetFrequencyId != null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
AlternativeVerb verb = new();
|
|
verb.Text = Loc.GetString("surveillance-camera-setup");
|
|
verb.Act = () => OpenSetupInterface(uid, verbs.User, component);
|
|
verbs.Verbs.Add(verb);
|
|
}
|
|
|
|
private void OnSetNetwork(EntityUid uid, SurveillanceCameraRouterComponent component,
|
|
SurveillanceCameraSetupSetNetwork args)
|
|
{
|
|
if (args.UiKey is not SurveillanceCameraSetupUiKey key
|
|
|| key != SurveillanceCameraSetupUiKey.Router)
|
|
{
|
|
return;
|
|
}
|
|
if (args.Network < 0 || args.Network >= component.AvailableNetworks.Count)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (!_prototypeManager.Resolve<DeviceFrequencyPrototype>(component.AvailableNetworks[args.Network],
|
|
out var frequency))
|
|
{
|
|
return;
|
|
}
|
|
|
|
component.SubnetFrequencyId = component.AvailableNetworks[args.Network];
|
|
component.SubnetFrequency = frequency.Frequency;
|
|
component.Active = true;
|
|
UpdateSetupInterface(uid, component);
|
|
}
|
|
|
|
private void OpenSetupInterface(EntityUid uid, EntityUid player, SurveillanceCameraRouterComponent? camera = null)
|
|
{
|
|
if (!Resolve(uid, ref camera))
|
|
return;
|
|
|
|
if (!_userInterface.TryOpenUi(uid, SurveillanceCameraSetupUiKey.Router, player))
|
|
return;
|
|
|
|
UpdateSetupInterface(uid, camera);
|
|
}
|
|
|
|
private void UpdateSetupInterface(EntityUid uid, SurveillanceCameraRouterComponent? router = null, DeviceNetworkComponent? deviceNet = null)
|
|
{
|
|
if (!Resolve(uid, ref router, ref deviceNet))
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (router.AvailableNetworks.Count == 0 || router.SubnetFrequencyId != null)
|
|
{
|
|
_userInterface.CloseUi(uid, SurveillanceCameraSetupUiKey.Router);
|
|
return;
|
|
}
|
|
|
|
var state = new SurveillanceCameraSetupBoundUiState(router.SubnetName, deviceNet.ReceiveFrequency ?? 0,
|
|
router.AvailableNetworks, true, router.SubnetFrequencyId != null);
|
|
_userInterface.SetUiState(uid, SurveillanceCameraSetupUiKey.Router, state);
|
|
}
|
|
|
|
private void SendHeartbeat(EntityUid uid, string origin, string destination,
|
|
SurveillanceCameraRouterComponent? router = null)
|
|
{
|
|
if (!Resolve(uid, ref router))
|
|
{
|
|
return;
|
|
}
|
|
|
|
var payload = new NetworkPayload()
|
|
{
|
|
{ DeviceNetworkConstants.Command, SurveillanceCameraSystem.CameraHeartbeatMessage },
|
|
{ SurveillanceCameraSystem.CameraAddressData, origin }
|
|
};
|
|
|
|
_deviceNetworkSystem.QueuePacket(uid, destination, payload, router.SubnetFrequency);
|
|
}
|
|
|
|
private void SubnetPingResponse(EntityUid uid, string origin, SurveillanceCameraRouterComponent? router = null)
|
|
{
|
|
if (!Resolve(uid, ref router) || router.SubnetFrequencyId == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
var payload = new NetworkPayload()
|
|
{
|
|
{ DeviceNetworkConstants.Command, SurveillanceCameraSystem.CameraSubnetData },
|
|
{ SurveillanceCameraSystem.CameraSubnetData, router.SubnetFrequencyId }
|
|
};
|
|
|
|
_deviceNetworkSystem.QueuePacket(uid, origin, payload);
|
|
}
|
|
|
|
private void ConnectCamera(EntityUid uid, string origin, string address, SurveillanceCameraRouterComponent? router = null)
|
|
{
|
|
if (!Resolve(uid, ref router))
|
|
{
|
|
return;
|
|
}
|
|
|
|
var payload = new NetworkPayload()
|
|
{
|
|
{ DeviceNetworkConstants.Command, SurveillanceCameraSystem.CameraConnectMessage },
|
|
{ SurveillanceCameraSystem.CameraAddressData, origin }
|
|
};
|
|
|
|
_deviceNetworkSystem.QueuePacket(uid, address, payload, router.SubnetFrequency);
|
|
}
|
|
|
|
// Adds a monitor to the set of routes.
|
|
private void AddMonitorToRoute(EntityUid uid, string address, SurveillanceCameraRouterComponent? router = null)
|
|
{
|
|
if (!Resolve(uid, ref router))
|
|
{
|
|
return;
|
|
}
|
|
|
|
router.MonitorRoutes.Add(address);
|
|
}
|
|
|
|
private void RemoveMonitorFromRoute(EntityUid uid, string address, SurveillanceCameraRouterComponent? router = null)
|
|
{
|
|
if (!Resolve(uid, ref router))
|
|
{
|
|
return;
|
|
}
|
|
|
|
router.MonitorRoutes.Remove(address);
|
|
}
|
|
|
|
// Pings a subnet to get all camera information.
|
|
private void PingSubnet(EntityUid uid, SurveillanceCameraRouterComponent? router = null)
|
|
{
|
|
if (!Resolve(uid, ref router))
|
|
{
|
|
return;
|
|
}
|
|
|
|
var payload = new NetworkPayload()
|
|
{
|
|
{ DeviceNetworkConstants.Command, SurveillanceCameraSystem.CameraPingMessage },
|
|
{ SurveillanceCameraSystem.CameraSubnetData, router.SubnetName }
|
|
};
|
|
|
|
_deviceNetworkSystem.QueuePacket(uid, null, payload, router.SubnetFrequency);
|
|
}
|
|
|
|
// Sends camera information to all monitors currently interested.
|
|
private void SendCameraInfo(EntityUid uid, NetworkPayload payload, SurveillanceCameraRouterComponent? router = null)
|
|
{
|
|
if (!Resolve(uid, ref router))
|
|
{
|
|
return;
|
|
}
|
|
|
|
foreach (var address in router.MonitorRoutes)
|
|
{
|
|
_deviceNetworkSystem.QueuePacket(uid, address, payload);
|
|
}
|
|
}
|
|
}
|