Remove outdated access reader method. (#19765)

This commit is contained in:
Leon Friedrich
2023-09-03 13:05:22 +12:00
committed by GitHub
parent 182b5267ad
commit af79f369ae
14 changed files with 86 additions and 81 deletions

View File

@@ -70,7 +70,7 @@ public sealed partial class ResearchConsoleMenu : FancyWindow
var hasAccess = _player.LocalPlayer?.ControlledEntity is not { } local || var hasAccess = _player.LocalPlayer?.ControlledEntity is not { } local ||
!_entity.TryGetComponent<AccessReaderComponent>(Entity, out var access) || !_entity.TryGetComponent<AccessReaderComponent>(Entity, out var access) ||
_accessReader.IsAllowed(local, access); _accessReader.IsAllowed(local, Entity, access);
foreach (var techId in _technologyDatabase.CurrentTechnologyCards) foreach (var techId in _technologyDatabase.CurrentTechnologyCards)
{ {
var tech = _prototype.Index<TechnologyPrototype>(techId); var tech = _prototype.Index<TechnologyPrototype>(techId);

View File

@@ -260,6 +260,6 @@ public sealed class AccessOverriderSystem : SharedAccessOverriderSystem
return true; return true;
var privilegedId = component.PrivilegedIdSlot.Item; var privilegedId = component.PrivilegedIdSlot.Item;
return privilegedId != null && _accessReader.IsAllowed(privilegedId.Value, reader); return privilegedId != null && _accessReader.IsAllowed(privilegedId.Value, uid, reader);
} }
} }

View File

@@ -188,7 +188,7 @@ public sealed class IdCardConsoleSystem : SharedIdCardConsoleSystem
return true; return true;
var privilegedId = component.PrivilegedIdSlot.Item; var privilegedId = component.PrivilegedIdSlot.Item;
return privilegedId != null && _accessReader.IsAllowed(privilegedId.Value, reader); return privilegedId != null && _accessReader.IsAllowed(privilegedId.Value, uid, reader);
} }
private void UpdateStationRecord(EntityUid uid, EntityUid targetId, string newFullName, string newJobTitle, JobPrototype? newJobProto) private void UpdateStationRecord(EntityUid uid, EntityUid targetId, string newFullName, string newJobTitle, JobPrototype? newJobProto)

View File

@@ -361,7 +361,7 @@ public sealed class AirAlarmSystem : EntitySystem
if (user == null) if (user == null)
return false; return false;
if (!_access.IsAllowed(user.Value, reader)) if (!_access.IsAllowed(user.Value, uid, reader))
{ {
_popup.PopupEntity(Loc.GetString("air-alarm-ui-access-denied"), user.Value, user.Value); _popup.PopupEntity(Loc.GetString("air-alarm-ui-access-denied"), user.Value, user.Value);
return false; return false;

View File

@@ -174,7 +174,7 @@ namespace Content.Server.Communications
if (TryComp<AccessReaderComponent>(console, out var accessReaderComponent) && !HasComp<EmaggedComponent>(console)) if (TryComp<AccessReaderComponent>(console, out var accessReaderComponent) && !HasComp<EmaggedComponent>(console))
{ {
return _accessReaderSystem.IsAllowed(user, accessReaderComponent); return _accessReaderSystem.IsAllowed(user, console, accessReaderComponent);
} }
return true; return true;
} }

View File

@@ -192,7 +192,7 @@ public sealed class NetworkConfiguratorSystem : SharedNetworkConfiguratorSystem
if (!TryComp(target, out AccessReaderComponent? reader) || user == null) if (!TryComp(target, out AccessReaderComponent? reader) || user == null)
return true; return true;
if (_accessSystem.IsAllowed(user.Value, reader)) if (_accessSystem.IsAllowed(user.Value, target, reader))
return true; return true;
_audioSystem.PlayPvs(component.SoundNoAccess, user.Value, AudioParams.Default.WithVolume(-2f).WithPitchScale(1.2f)); _audioSystem.PlayPvs(component.SoundNoAccess, user.Value, AudioParams.Default.WithVolume(-2f).WithPitchScale(1.2f));

View File

@@ -232,7 +232,7 @@ public sealed class NewsSystem : EntitySystem
{ {
if (EntityManager.TryGetComponent<AccessReaderComponent>(device, out var accessReader) && if (EntityManager.TryGetComponent<AccessReaderComponent>(device, out var accessReader) &&
user.HasValue && user.HasValue &&
_accessReader.IsAllowed(user.Value, accessReader)) _accessReader.IsAllowed(user.Value, device, accessReader))
{ {
return true; return true;
} }

View File

@@ -57,7 +57,7 @@ namespace Content.Server.Power.EntitySystems
if (args.Session.AttachedEntity == null) if (args.Session.AttachedEntity == null)
return; return;
if (access == null || _accessReader.IsAllowed(args.Session.AttachedEntity.Value, access)) if (access == null || _accessReader.IsAllowed(args.Session.AttachedEntity.Value, uid, access))
{ {
component.HasAccess = true; component.HasAccess = true;
} }
@@ -82,7 +82,7 @@ namespace Content.Server.Power.EntitySystems
if (args.Session.AttachedEntity == null) if (args.Session.AttachedEntity == null)
return; return;
if (access == null || _accessReader.IsAllowed(args.Session.AttachedEntity.Value, access)) if (access == null || _accessReader.IsAllowed(args.Session.AttachedEntity.Value, uid, access))
{ {
ApcToggleBreaker(uid, component); ApcToggleBreaker(uid, component);
} }

View File

@@ -25,7 +25,7 @@ public sealed partial class ResearchSystem
if (!this.IsPowered(uid, EntityManager)) if (!this.IsPowered(uid, EntityManager))
return; return;
if (TryComp<AccessReaderComponent>(uid, out var access) && !_accessReader.IsAllowed(ent, access)) if (TryComp<AccessReaderComponent>(uid, out var access) && !_accessReader.IsAllowed(ent, uid, access))
{ {
_popup.PopupEntity(Loc.GetString("research-console-no-access-popup"), ent); _popup.PopupEntity(Loc.GetString("research-console-no-access-popup"), ent);
return; return;

View File

@@ -226,7 +226,7 @@ namespace Content.Server.VendingMachines
if (!TryComp<AccessReaderComponent?>(uid, out var accessReader)) if (!TryComp<AccessReaderComponent?>(uid, out var accessReader))
return true; return true;
if (_accessReader.IsAllowed(sender, accessReader) || HasComp<EmaggedComponent>(uid)) if (_accessReader.IsAllowed(sender, uid, accessReader) || HasComp<EmaggedComponent>(uid))
return true; return true;
Popup.PopupEntity(Loc.GetString("vending-machine-component-try-eject-access-denied"), uid); Popup.PopupEntity(Loc.GetString("vending-machine-component-try-eject-access-denied"), uid);

View File

@@ -26,25 +26,30 @@ public sealed partial class AccessReaderComponent : Component
public HashSet<string> DenyTags = new(); public HashSet<string> DenyTags = new();
/// <summary> /// <summary>
/// List of access lists to check allowed against. For an access check to pass /// List of access groups that grant access to this reader. Only a single matching group is required to gain access.
/// there has to be an access list that is a subset of the access in the checking list. /// A group matches if it is a subset of the set being checked against.
/// </summary> /// </summary>
[DataField("access")] [DataField("access")]
public List<HashSet<string>> AccessLists = new(); public List<HashSet<string>> AccessLists = new();
/// <summary> /// <summary>
/// A list of valid stationrecordkeys /// A list of <see cref="StationRecordKey"/>s that grant access. Only a single matching key is required tp gaim
/// access.
/// </summary> /// </summary>
[DataField("accessKeys")] [DataField("accessKeys")]
public HashSet<StationRecordKey> AccessKeys = new(); public HashSet<StationRecordKey> AccessKeys = new();
/// <summary> /// <summary>
/// The name of the container in which additional /// If specified, then this access reader will instead pull access requirements from entities contained in the
/// AccessReaderComponents may be found. /// given container.
/// </summary> /// </summary>
/// <remarks>
/// This effectively causes <see cref="DenyTags"/>, <see cref="AccessLists"/>, and <see cref="AccessKeys"/> to be
/// ignored, though <see cref="Enabled"/> is still respected. Access is denied if there are no valid entities or
/// they all deny access.
/// </remarks>
[DataField("containerAccessProvider")] [DataField("containerAccessProvider")]
public string? ContainerAccessProvider = null; public string? ContainerAccessProvider;
} }
[Serializable, NetSerializable] [Serializable, NetSerializable]

View File

@@ -53,7 +53,7 @@ public sealed class AccessReaderSystem : EntitySystem
{ {
if (args.User == null) // AutoLink (and presumably future external linkers) have no user. if (args.User == null) // AutoLink (and presumably future external linkers) have no user.
return; return;
if (!HasComp<EmaggedComponent>(uid) && !IsAllowed(args.User.Value, component)) if (!HasComp<EmaggedComponent>(uid) && !IsAllowed(args.User.Value, uid, component))
args.Cancel(); args.Cancel();
} }
@@ -64,80 +64,65 @@ public sealed class AccessReaderSystem : EntitySystem
Dirty(reader); Dirty(reader);
} }
/// <summary>
/// Finds all AccessReaderComponents in the container of the
/// required entity.
/// </summary>
/// <param name="target">The entity to search for a container</param>
/// <param name="accessReader"></param>
/// <param name="result"></param>
private bool FindAccessReadersInContainer(EntityUid target, AccessReaderComponent accessReader, out List<AccessReaderComponent> result)
{
result = new();
if (accessReader.ContainerAccessProvider == null)
return false;
if (!_containerSystem.TryGetContainer(target, accessReader.ContainerAccessProvider, out var container))
return false;
foreach (var entity in container.ContainedEntities)
{
if (TryComp<AccessReaderComponent>(entity, out var entityAccessReader))
result.Add(entityAccessReader);
}
return result.Any();
}
/// <summary> /// <summary>
/// Searches the source for access tags /// Searches the source for access tags
/// then compares it with the all targets accesses to see if it is allowed. /// then compares it with the all targets accesses to see if it is allowed.
/// </summary> /// </summary>
/// <param name="source">The entity that wants access.</param> /// <param name="user">The entity that wants access.</param>
/// <param name="target">The entity to search for an access reader</param> /// <param name="target">The entity to search for an access reader</param>
/// <param name="reader">Optional reader from the target entity</param> /// <param name="reader">Optional reader from the target entity</param>
public bool IsAllowed(EntityUid source, EntityUid target, AccessReaderComponent? reader = null) public bool IsAllowed(EntityUid user, EntityUid target, AccessReaderComponent? reader = null)
{ {
if (!Resolve(target, ref reader, false)) if (!Resolve(target, ref reader, false))
return true; return true;
if (FindAccessReadersInContainer(target, reader, out var accessReaderList))
{
foreach (var access in accessReaderList)
{
if (IsAllowed(source, access))
return true;
}
return false;
}
return IsAllowed(source, reader);
}
/// <summary>
/// Searches the given entity for access tags
/// then compares it with the readers access list to see if it is allowed.
/// </summary>
/// <param name="entity">The entity that wants access.</param>
/// <param name="reader">A reader from a different entity</param>
public bool IsAllowed(EntityUid entity, AccessReaderComponent reader)
{
// Access reader is totally disabled, so access is always allowed.
if (!reader.Enabled) if (!reader.Enabled)
return true; return true;
var allEnts = FindPotentialAccessItems(entity); var accessSources = FindPotentialAccessItems(user);
var access = FindAccessTags(user, accessSources);
FindStationRecordKeys(user, out var stationKeys, accessSources);
if (AreAccessTagsAllowed(FindAccessTags(entity, allEnts), reader)) return IsAllowed(access, stationKeys, target, reader);
}
/// <summary>
/// Check whether the given access permissions satisfy an access reader's requirements.
/// </summary>
public bool IsAllowed(
ICollection<string> access,
ICollection<StationRecordKey> stationKeys,
EntityUid target,
AccessReaderComponent reader)
{
if (!reader.Enabled)
return true; return true;
if (FindStationRecordKeys(entity, out var recordKeys, allEnts) if (reader.ContainerAccessProvider == null)
&& AreStationRecordKeysAllowed(recordKeys, reader)) return IsAllowedInternal(access, stationKeys, reader);
if (!_containerSystem.TryGetContainer(target, reader.ContainerAccessProvider, out var container))
return false;
foreach (var entity in container.ContainedEntities)
{
if (!TryComp(entity, out AccessReaderComponent? containedReader))
continue;
if (IsAllowed(access, stationKeys, entity, containedReader))
return true; return true;
}
return false; return false;
} }
private bool IsAllowedInternal(ICollection<string> access, ICollection<StationRecordKey> stationKeys, AccessReaderComponent reader)
{
return !reader.Enabled
|| AreAccessTagsAllowed(access, reader)
|| AreStationRecordKeysAllowed(stationKeys, reader);
}
/// <summary> /// <summary>
/// Compares the given tags with the readers access list to see if it is allowed. /// Compares the given tags with the readers access list to see if it is allowed.
/// </summary> /// </summary>
@@ -155,7 +140,16 @@ public sealed class AccessReaderSystem : EntitySystem
return false; return false;
} }
return reader.AccessLists.Count == 0 || reader.AccessLists.Any(a => a.IsSubsetOf(accessTags)); if (reader.AccessLists.Count == 0)
return true;
foreach (var set in reader.AccessLists)
{
if (set.IsSubsetOf(accessTags))
return true;
}
return false;
} }
/// <summary> /// <summary>
@@ -163,7 +157,13 @@ public sealed class AccessReaderSystem : EntitySystem
/// </summary> /// </summary>
public bool AreStationRecordKeysAllowed(ICollection<StationRecordKey> keys, AccessReaderComponent reader) public bool AreStationRecordKeysAllowed(ICollection<StationRecordKey> keys, AccessReaderComponent reader)
{ {
return keys.Any() && reader.AccessKeys.Any(keys.Contains); foreach (var key in reader.AccessKeys)
{
if (keys.Contains(key))
return true;
}
return false;
} }
/// <summary> /// <summary>

View File

@@ -509,9 +509,9 @@ public abstract partial class SharedDoorSystem : EntitySystem
return AccessType switch return AccessType switch
{ {
// Some game modes modify access rules. // Some game modes modify access rules.
AccessTypes.AllowAllIdExternal => !isExternal || _accessReaderSystem.IsAllowed(user.Value, access), AccessTypes.AllowAllIdExternal => !isExternal || _accessReaderSystem.IsAllowed(user.Value, uid, access),
AccessTypes.AllowAllNoExternal => !isExternal, AccessTypes.AllowAllNoExternal => !isExternal,
_ => _accessReaderSystem.IsAllowed(user.Value, access) _ => _accessReaderSystem.IsAllowed(user.Value, uid, access)
}; };
} }

View File

@@ -183,7 +183,7 @@ public sealed class LockSystem : EntitySystem
if (!Resolve(uid, ref reader, false)) if (!Resolve(uid, ref reader, false))
return true; return true;
if (_accessReader.IsAllowed(user, reader)) if (_accessReader.IsAllowed(user, uid, reader))
return true; return true;
if (!quiet) if (!quiet)