Files
tbd-station-14/Content.Server/Lathe/LatheSystem.cs
Pieter-Jan Briers 0c97520276 Fix usages of TryIndex() (#39124)
* 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>
2025-09-09 18:17:56 +02:00

571 lines
23 KiB
C#

using System.Diagnostics.CodeAnalysis;
using System.Linq;
using Content.Server.Administration.Logs;
using Content.Server.Atmos.EntitySystems;
using Content.Server.Fluids.EntitySystems;
using Content.Server.Lathe.Components;
using Content.Server.Materials;
using Content.Server.Popups;
using Content.Server.Power.Components;
using Content.Server.Power.EntitySystems;
using Content.Server.Radio.EntitySystems;
using Content.Server.Stack;
using Content.Shared.Atmos;
using Content.Shared.Chemistry.Components;
using Content.Shared.Chemistry.EntitySystems;
using Content.Shared.Chemistry.Reagent;
using Content.Shared.UserInterface;
using Content.Shared.Database;
using Content.Shared.Emag.Components;
using Content.Shared.Emag.Systems;
using Content.Shared.Examine;
using Content.Shared.Lathe;
using Content.Shared.Lathe.Prototypes;
using Content.Shared.Localizations;
using Content.Shared.Materials;
using Content.Shared.Power;
using Content.Shared.ReagentSpeed;
using Content.Shared.Research.Components;
using Content.Shared.Research.Prototypes;
using JetBrains.Annotations;
using Robust.Server.Containers;
using Robust.Server.GameObjects;
using Robust.Shared.Audio.Systems;
using Robust.Shared.Prototypes;
using Robust.Shared.Timing;
namespace Content.Server.Lathe
{
[UsedImplicitly]
public sealed class LatheSystem : SharedLatheSystem
{
[Dependency] private readonly IGameTiming _timing = default!;
[Dependency] private readonly IPrototypeManager _proto = default!;
[Dependency] private readonly IAdminLogManager _adminLogger = default!;
[Dependency] private readonly AtmosphereSystem _atmosphere = default!;
[Dependency] private readonly SharedAppearanceSystem _appearance = default!;
[Dependency] private readonly SharedAudioSystem _audio = default!;
[Dependency] private readonly ContainerSystem _container = default!;
[Dependency] private readonly EmagSystem _emag = default!;
[Dependency] private readonly UserInterfaceSystem _uiSys = default!;
[Dependency] private readonly MaterialStorageSystem _materialStorage = default!;
[Dependency] private readonly PopupSystem _popup = default!;
[Dependency] private readonly PuddleSystem _puddle = default!;
[Dependency] private readonly ReagentSpeedSystem _reagentSpeed = default!;
[Dependency] private readonly SharedSolutionContainerSystem _solution = default!;
[Dependency] private readonly StackSystem _stack = default!;
[Dependency] private readonly TransformSystem _transform = default!;
[Dependency] private readonly RadioSystem _radio = default!;
/// <summary>
/// Per-tick cache
/// </summary>
private readonly List<GasMixture> _environments = new();
public override void Initialize()
{
base.Initialize();
SubscribeLocalEvent<LatheComponent, GetMaterialWhitelistEvent>(OnGetWhitelist);
SubscribeLocalEvent<LatheComponent, MapInitEvent>(OnMapInit);
SubscribeLocalEvent<LatheComponent, PowerChangedEvent>(OnPowerChanged);
SubscribeLocalEvent<LatheComponent, TechnologyDatabaseModifiedEvent>(OnDatabaseModified);
SubscribeLocalEvent<LatheAnnouncingComponent, TechnologyDatabaseModifiedEvent>(OnTechnologyDatabaseModified);
SubscribeLocalEvent<LatheComponent, ResearchRegistrationChangedEvent>(OnResearchRegistrationChanged);
SubscribeLocalEvent<LatheComponent, LatheQueueRecipeMessage>(OnLatheQueueRecipeMessage);
SubscribeLocalEvent<LatheComponent, LatheSyncRequestMessage>(OnLatheSyncRequestMessage);
SubscribeLocalEvent<LatheComponent, LatheDeleteRequestMessage>(OnLatheDeleteRequestMessage);
SubscribeLocalEvent<LatheComponent, LatheMoveRequestMessage>(OnLatheMoveRequestMessage);
SubscribeLocalEvent<LatheComponent, LatheAbortFabricationMessage>(OnLatheAbortFabricationMessage);
SubscribeLocalEvent<LatheComponent, BeforeActivatableUIOpenEvent>((u, c, _) => UpdateUserInterfaceState(u, c));
SubscribeLocalEvent<LatheComponent, MaterialAmountChangedEvent>(OnMaterialAmountChanged);
SubscribeLocalEvent<TechnologyDatabaseComponent, LatheGetRecipesEvent>(OnGetRecipes);
SubscribeLocalEvent<EmagLatheRecipesComponent, LatheGetRecipesEvent>(GetEmagLatheRecipes);
SubscribeLocalEvent<LatheHeatProducingComponent, LatheStartPrintingEvent>(OnHeatStartPrinting);
}
public override void Update(float frameTime)
{
var query = EntityQueryEnumerator<LatheProducingComponent, LatheComponent>();
while (query.MoveNext(out var uid, out var comp, out var lathe))
{
if (lathe.CurrentRecipe == null)
continue;
if (_timing.CurTime - comp.StartTime >= comp.ProductionLength)
FinishProducing(uid, lathe);
}
var heatQuery = EntityQueryEnumerator<LatheHeatProducingComponent, LatheProducingComponent, TransformComponent>();
while (heatQuery.MoveNext(out var uid, out var heatComp, out _, out var xform))
{
if (_timing.CurTime < heatComp.NextSecond)
continue;
heatComp.NextSecond += TimeSpan.FromSeconds(1);
var position = _transform.GetGridTilePositionOrDefault((uid, xform));
_environments.Clear();
if (_atmosphere.GetTileMixture(xform.GridUid, xform.MapUid, position, true) is { } tileMix)
_environments.Add(tileMix);
if (xform.GridUid != null)
{
var enumerator = _atmosphere.GetAdjacentTileMixtures(xform.GridUid.Value, position, false, true);
while (enumerator.MoveNext(out var mix))
{
_environments.Add(mix);
}
}
if (_environments.Count > 0)
{
var heatPerTile = heatComp.EnergyPerSecond / _environments.Count;
foreach (var env in _environments)
{
_atmosphere.AddHeat(env, heatPerTile);
}
}
}
}
private void OnGetWhitelist(EntityUid uid, LatheComponent component, ref GetMaterialWhitelistEvent args)
{
if (args.Storage != uid)
return;
var materialWhitelist = new List<ProtoId<MaterialPrototype>>();
var recipes = GetAvailableRecipes(uid, component, true);
foreach (var id in recipes)
{
if (!_proto.Resolve(id, out var proto))
continue;
foreach (var (mat, _) in proto.Materials)
{
if (!materialWhitelist.Contains(mat))
{
materialWhitelist.Add(mat);
}
}
}
var combined = args.Whitelist.Union(materialWhitelist).ToList();
args.Whitelist = combined;
}
[PublicAPI]
public bool TryGetAvailableRecipes(EntityUid uid, [NotNullWhen(true)] out List<ProtoId<LatheRecipePrototype>>? recipes, [NotNullWhen(true)] LatheComponent? component = null, bool getUnavailable = false)
{
recipes = null;
if (!Resolve(uid, ref component))
return false;
recipes = GetAvailableRecipes(uid, component, getUnavailable);
return true;
}
public List<ProtoId<LatheRecipePrototype>> GetAvailableRecipes(EntityUid uid, LatheComponent component, bool getUnavailable = false)
{
var ev = new LatheGetRecipesEvent((uid, component), getUnavailable);
AddRecipesFromPacks(ev.Recipes, component.StaticPacks);
RaiseLocalEvent(uid, ev);
return ev.Recipes.ToList();
}
public bool TryAddToQueue(EntityUid uid, LatheRecipePrototype recipe, int quantity, LatheComponent? component = null)
{
if (!Resolve(uid, ref component))
return false;
if (quantity <= 0)
return false;
quantity = int.Min(quantity, MaxItemsPerRequest);
if (!CanProduce(uid, recipe, quantity, component))
return false;
foreach (var (mat, amount) in recipe.Materials)
{
var adjustedAmount = recipe.ApplyMaterialDiscount
? (int)(-amount * component.MaterialUseMultiplier)
: -amount;
adjustedAmount *= quantity;
_materialStorage.TryChangeMaterialAmount(uid, mat, adjustedAmount);
}
if (component.Queue.Last is { } node && node.ValueRef.Recipe == recipe.ID)
node.ValueRef.ItemsRequested += quantity;
else
component.Queue.AddLast(new LatheRecipeBatch(recipe.ID, 0, quantity));
return true;
}
public bool TryStartProducing(EntityUid uid, LatheComponent? component = null)
{
if (!Resolve(uid, ref component))
return false;
if (component.CurrentRecipe != null || component.Queue.Count <= 0 || !this.IsPowered(uid, EntityManager))
return false;
var batch = component.Queue.First();
batch.ItemsPrinted++;
if (batch.ItemsPrinted >= batch.ItemsRequested || batch.ItemsPrinted < 0) // Rollover sanity check
component.Queue.RemoveFirst();
var recipe = _proto.Index(batch.Recipe);
var time = _reagentSpeed.ApplySpeed(uid, recipe.CompleteTime) * component.TimeMultiplier;
var lathe = EnsureComp<LatheProducingComponent>(uid);
lathe.StartTime = _timing.CurTime;
lathe.ProductionLength = time;
component.CurrentRecipe = recipe;
var ev = new LatheStartPrintingEvent(recipe);
RaiseLocalEvent(uid, ref ev);
_audio.PlayPvs(component.ProducingSound, uid);
UpdateRunningAppearance(uid, true);
UpdateUserInterfaceState(uid, component);
if (time == TimeSpan.Zero)
{
FinishProducing(uid, component, lathe);
}
return true;
}
public void FinishProducing(EntityUid uid, LatheComponent? comp = null, LatheProducingComponent? prodComp = null)
{
if (!Resolve(uid, ref comp, ref prodComp, false))
return;
if (comp.CurrentRecipe != null)
{
var currentRecipe = _proto.Index(comp.CurrentRecipe.Value);
if (currentRecipe.Result is { } resultProto)
{
var result = Spawn(resultProto, Transform(uid).Coordinates);
_stack.TryMergeToContacts(result);
}
if (currentRecipe.ResultReagents is { } resultReagents &&
comp.ReagentOutputSlotId is { } slotId)
{
var toAdd = new Solution(
resultReagents.Select(p => new ReagentQuantity(p.Key.Id, p.Value, null)));
// dispense it in the container if we have it and dump it if we don't
if (_container.TryGetContainer(uid, slotId, out var container) &&
container.ContainedEntities.Count == 1 &&
_solution.TryGetFitsInDispenser(container.ContainedEntities.First(), out var solution, out _))
{
_solution.AddSolution(solution.Value, toAdd);
}
else
{
_popup.PopupEntity(Loc.GetString("lathe-reagent-dispense-no-container", ("name", uid)), uid);
_puddle.TrySpillAt(uid, toAdd, out _);
}
}
}
comp.CurrentRecipe = null;
prodComp.StartTime = _timing.CurTime;
if (!TryStartProducing(uid, comp))
{
RemCompDeferred(uid, prodComp);
UpdateUserInterfaceState(uid, comp);
UpdateRunningAppearance(uid, false);
}
}
public void UpdateUserInterfaceState(EntityUid uid, LatheComponent? component = null)
{
if (!Resolve(uid, ref component))
return;
var producing = component.CurrentRecipe;
if (producing == null && component.Queue.First is { } node)
producing = node.Value.Recipe;
var state = new LatheUpdateState(GetAvailableRecipes(uid, component), component.Queue.ToArray(), producing);
_uiSys.SetUiState(uid, LatheUiKey.Key, state);
}
/// <summary>
/// Adds every unlocked recipe from each pack to the recipes list.
/// </summary>
public void AddRecipesFromDynamicPacks(ref LatheGetRecipesEvent args, TechnologyDatabaseComponent database, IEnumerable<ProtoId<LatheRecipePackPrototype>> packs)
{
foreach (var id in packs)
{
var pack = _proto.Index(id);
foreach (var recipe in pack.Recipes)
{
if (args.GetUnavailable || database.UnlockedRecipes.Contains(recipe))
args.Recipes.Add(recipe);
}
}
}
private void OnGetRecipes(EntityUid uid, TechnologyDatabaseComponent component, LatheGetRecipesEvent args)
{
if (uid == args.Lathe)
AddRecipesFromDynamicPacks(ref args, component, args.Comp.DynamicPacks);
}
private void GetEmagLatheRecipes(EntityUid uid, EmagLatheRecipesComponent component, LatheGetRecipesEvent args)
{
if (uid != args.Lathe)
return;
if (!args.GetUnavailable && !_emag.CheckFlag(uid, EmagType.Interaction))
return;
AddRecipesFromPacks(args.Recipes, component.EmagStaticPacks);
if (TryComp<TechnologyDatabaseComponent>(uid, out var database))
AddRecipesFromDynamicPacks(ref args, database, component.EmagDynamicPacks);
}
private void OnHeatStartPrinting(EntityUid uid, LatheHeatProducingComponent component, LatheStartPrintingEvent args)
{
component.NextSecond = _timing.CurTime;
}
private void OnMaterialAmountChanged(EntityUid uid, LatheComponent component, ref MaterialAmountChangedEvent args)
{
UpdateUserInterfaceState(uid, component);
}
/// <summary>
/// Initialize the UI and appearance.
/// Appearance requires initialization or the layers break
/// </summary>
private void OnMapInit(EntityUid uid, LatheComponent component, MapInitEvent args)
{
_appearance.SetData(uid, LatheVisuals.IsInserting, false);
_appearance.SetData(uid, LatheVisuals.IsRunning, false);
_materialStorage.UpdateMaterialWhitelist(uid);
}
/// <summary>
/// Sets the machine sprite to either play the running animation
/// or stop.
/// </summary>
private void UpdateRunningAppearance(EntityUid uid, bool isRunning)
{
_appearance.SetData(uid, LatheVisuals.IsRunning, isRunning);
}
private void OnPowerChanged(EntityUid uid, LatheComponent component, ref PowerChangedEvent args)
{
if (!args.Powered)
{
AbortProduction(uid);
}
else
{
TryStartProducing(uid, component);
}
}
private void OnDatabaseModified(EntityUid uid, LatheComponent component, ref TechnologyDatabaseModifiedEvent args)
{
UpdateUserInterfaceState(uid, component);
}
private void OnTechnologyDatabaseModified(Entity<LatheAnnouncingComponent> ent, ref TechnologyDatabaseModifiedEvent args)
{
if (args.NewlyUnlockedRecipes is null)
return;
if (!TryGetAvailableRecipes(ent.Owner, out var potentialRecipes))
return;
var recipeNames = new List<string>();
foreach (var recipeId in args.NewlyUnlockedRecipes)
{
if (!potentialRecipes.Contains(new(recipeId)))
continue;
if (!_proto.TryIndex(recipeId, out LatheRecipePrototype? recipe))
continue;
var itemName = GetRecipeName(recipe!);
recipeNames.Add(Loc.GetString("lathe-unlock-recipe-radio-broadcast-item", ("item", itemName)));
}
if (recipeNames.Count == 0)
return;
var message =
recipeNames.Count > ent.Comp.MaximumItems ?
Loc.GetString(
"lathe-unlock-recipe-radio-broadcast-overflow",
("items", ContentLocalizationManager.FormatList(recipeNames.GetRange(0, ent.Comp.MaximumItems))),
("count", recipeNames.Count)
) :
Loc.GetString(
"lathe-unlock-recipe-radio-broadcast",
("items", ContentLocalizationManager.FormatList(recipeNames))
);
foreach (var channel in ent.Comp.Channels)
{
_radio.SendRadioMessage(ent.Owner, message, channel, ent.Owner, escapeMarkup: false);
}
}
private void OnResearchRegistrationChanged(EntityUid uid, LatheComponent component, ref ResearchRegistrationChangedEvent args)
{
UpdateUserInterfaceState(uid, component);
}
protected override bool HasRecipe(EntityUid uid, LatheRecipePrototype recipe, LatheComponent component)
{
return GetAvailableRecipes(uid, component).Contains(recipe.ID);
}
public void AbortProduction(EntityUid uid, LatheComponent? component = null)
{
if (!Resolve(uid, ref component))
return;
if (component.CurrentRecipe != null)
{
if (component.Queue.Count > 0)
{
// Batch abandoned while printing last item, need to create a one-item batch
var batch = component.Queue.First();
if (batch.Recipe != component.CurrentRecipe)
{
var newBatch = new LatheRecipeBatch(component.CurrentRecipe.Value, 0, 1);
component.Queue.AddFirst(newBatch);
}
else if (batch.ItemsPrinted > 0)
{
batch.ItemsPrinted--;
}
}
component.CurrentRecipe = null;
}
RemCompDeferred<LatheProducingComponent>(uid);
UpdateUserInterfaceState(uid, component);
UpdateRunningAppearance(uid, false);
}
#region UI Messages
private void OnLatheQueueRecipeMessage(EntityUid uid, LatheComponent component, LatheQueueRecipeMessage args)
{
if (_proto.TryIndex(args.ID, out LatheRecipePrototype? recipe))
{
if (TryAddToQueue(uid, recipe, args.Quantity, component))
{
_adminLogger.Add(LogType.Action,
LogImpact.Low,
$"{ToPrettyString(args.Actor):player} queued {args.Quantity} {GetRecipeName(recipe)} at {ToPrettyString(uid):lathe}");
}
}
TryStartProducing(uid, component);
UpdateUserInterfaceState(uid, component);
}
private void OnLatheSyncRequestMessage(EntityUid uid, LatheComponent component, LatheSyncRequestMessage args)
{
UpdateUserInterfaceState(uid, component);
}
/// <summary>
/// Removes a batch from the batch queue by index.
/// If the index given does not exist or is outside of the bounds of the lathe's batch queue, nothing happens.
/// </summary>
/// <param name="uid">The lathe whose queue is being altered.</param>
/// <param name="component"></param>
/// <param name="args"></param>
public void OnLatheDeleteRequestMessage(EntityUid uid, LatheComponent component, ref LatheDeleteRequestMessage args)
{
if (args.Index < 0 || args.Index >= component.Queue.Count)
return;
var node = component.Queue.First;
for (int i = 0; i < args.Index; i++)
node = node?.Next;
if (node == null) // Shouldn't happen with checks above.
return;
var batch = node.Value;
_adminLogger.Add(LogType.Action,
LogImpact.Low,
$"{ToPrettyString(args.Actor):player} deleted a lathe job for ({batch.ItemsPrinted}/{batch.ItemsRequested}) {GetRecipeName(batch.Recipe)} at {ToPrettyString(uid):lathe}");
component.Queue.Remove(node);
UpdateUserInterfaceState(uid, component);
}
public void OnLatheMoveRequestMessage(EntityUid uid, LatheComponent component, ref LatheMoveRequestMessage args)
{
if (args.Change == 0 || args.Index < 0 || args.Index >= component.Queue.Count)
return;
// New index must be within the bounds of the batch.
var newIndex = args.Index + args.Change;
if (newIndex < 0 || newIndex >= component.Queue.Count)
return;
var node = component.Queue.First;
for (int i = 0; i < args.Index; i++)
node = node?.Next;
if (node == null) // Something went wrong.
return;
if (args.Change > 0)
{
var newRelativeNode = node.Next;
for (int i = 1; i < args.Change; i++) // 1-indexed: starting from Next
newRelativeNode = newRelativeNode?.Next;
if (newRelativeNode == null) // Something went wrong.
return;
component.Queue.Remove(node);
component.Queue.AddAfter(newRelativeNode, node);
}
else
{
var newRelativeNode = node.Previous;
for (int i = 1; i < -args.Change; i++) // 1-indexed: starting from Previous
newRelativeNode = newRelativeNode?.Previous;
if (newRelativeNode == null) // Something went wrong.
return;
component.Queue.Remove(node);
component.Queue.AddBefore(newRelativeNode, node);
}
UpdateUserInterfaceState(uid, component);
}
public void OnLatheAbortFabricationMessage(EntityUid uid, LatheComponent component, ref LatheAbortFabricationMessage args)
{
if (component.CurrentRecipe == null)
return;
_adminLogger.Add(LogType.Action,
LogImpact.Low,
$"{ToPrettyString(args.Actor):player} aborted printing {GetRecipeName(component.CurrentRecipe.Value)} at {ToPrettyString(uid):lathe}");
component.CurrentRecipe = null;
FinishProducing(uid, component);
}
#endregion
}
}