space-wizards/RobustToolbox
1
0
Fork 0
mirror of https://github.com/space-wizards/RobustToolbox.git synced 2026-02-15 03:30:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Validate default values of ProtoId and EntProtoId fields (#4462)

Browse Source
This commit is contained in:
Leon Friedrich
2023-10-02 03:49:45 +11:00
committed by GitHub
parent 58aa6e5c75
commit 01ce244b7b
4 changed files with 35 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Robust.Shared/Localization/LocId.cs
View File

@@ -38,4 +38,6 @@ public readonly record struct LocId(string Id) : IEquatable<string>, IComparable
{
return string.Compare(Id, other.Id, StringComparison.Ordinal);
}
public override string ToString() => Id ?? String.Empty;
}

2
Robust.Shared/Prototypes/EntProtoId.cs
View File

@@ -39,4 +39,6 @@ public readonly record struct EntProtoId(string Id) : IEquatable<string>, ICompa
{
return string.Compare(Id, other.Id, StringComparison.Ordinal);
}
public override string ToString() => Id ?? string.Empty;
}

2
Robust.Shared/Prototypes/ProtoId.cs
View File

@@ -39,4 +39,6 @@ public readonly record struct ProtoId<T>(string Id) : IEquatable<string>, ICompa
{
return string.Compare(Id, other.Id, StringComparison.Ordinal);
}
public override string ToString() => Id ?? string.Empty;
}

48
Robust.Shared/Prototypes/PrototypeManager.ValidateFields.cs
View File

@@ -60,24 +60,18 @@ public partial class PrototypeManager
if (!TryGetFieldPrototype(field, out var proto, out var canBeNull, out var canBeEmpty))
return;
if (field.FieldType != typeof(string))
{
errors.Add($"Prototype id field failed validation. Field is not a string. Field: {field.Name} in {type.FullName}");
return;
}
if (!TryGetFieldValue(field, type, ref instance, errors, out var value))
return;
if (value == null)
var id = value?.ToString();
if (id == null)
{
if (!canBeNull)
errors.Add($"Prototype id field failed validation. Const/Static fields should not be null. Field: {field.Name} in {type.FullName}");
errors.Add($"Prototype id field failed validation. Fields should not be null. Field: {field.Name} in {type.FullName}");
return;
}
var id = (string) value;
if (string.IsNullOrWhiteSpace(id))
{
if (!canBeEmpty)
@@ -141,7 +135,6 @@ public partial class PrototypeManager
canBeNull = false;
canBeEmpty = false;
// Check for a [PrototypeId] attribute.
var attrib = field.GetCustomAttribute(typeof(ValidatePrototypeIdAttribute<>), false);
if (attrib != null)
{
@@ -149,16 +142,39 @@ public partial class PrototypeManager
return true;
}
// Next, check for a data field attribute.
if (!field.TryGetCustomAttribute(out DataFieldAttribute? dataField))
return false;
var fieldType = field.FieldType;
canBeEmpty = dataField.Required;
DebugTools.Assert(!field.IsStatic);
// Resolve nullable structs
if (fieldType.IsGenericType && fieldType.GetGenericTypeDefinition() == typeof(Nullable<>))
{
fieldType = fieldType.GetGenericArguments().Single();
canBeNull = true;
}
if (fieldType == typeof(EntProtoId))
{
proto = typeof(EntityPrototype);
return true;
}
if (fieldType.IsGenericType && field.FieldType.GetGenericTypeDefinition() == typeof(ProtoId<>))
{
proto = field.FieldType.GetGenericArguments().Single();
return true;
}
// As far as I know there is no way to check for the nullability of a string field, so we will assume that null
// values imply that the field itself is properly marked as nullable.
canBeNull = true;
if (dataField.CustomTypeSerializer == null)
return false;
// Check that this is a prototype id serializer
if (!dataField.CustomTypeSerializer.IsGenericType)
return false;
@@ -166,12 +182,6 @@ public partial class PrototypeManager
return false;
proto = dataField.CustomTypeSerializer.GetGenericArguments().First();
canBeEmpty = dataField.Required;
// We will assume null values imply that the field itself is marked as nullable.
// Unless someone can tell me how to figure out the nullability of a string field.
canBeNull = true;
return true;
}
}