StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add error code to SContentLoadException

This commit is contained in:
Jesse Plamondon-Willard 2022-05-11 17:12:58 -04:00
parent 8c8ec6a457
commit e14916f962
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
7 changed files with 54 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/SMAPI/Framework/ContentManagers/BaseContentManager.cs
View File

@ -198,9 +198,9 @@ namespace StardewModdingAPI.Framework.ContentManagers
// NOTE: the game checks for ContentLoadException to handle invalid keys, so avoid
// throwing other types like ArgumentException here.
if (string.IsNullOrWhiteSpace(assetName))
throw new SContentLoadException("The asset key or local path is empty.");
throw new SContentLoadException(ContentLoadErrorType.InvalidName, "The asset key or local path is empty.");
if (assetName.Intersect(Path.GetInvalidPathChars()).Any())
throw new SContentLoadException("The asset key or local path contains invalid characters.");
throw new SContentLoadException(ContentLoadErrorType.InvalidName, "The asset key or local path contains invalid characters.");
return this.Cache.NormalizeKey(assetName);
}

27
src/SMAPI/Framework/ContentManagers/ModContentManager.cs
View File

@ -94,7 +94,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
if (this.Coordinator.TryParseManagedAssetKey(assetName.Name, out string? contentManagerID, out IAssetName? relativePath))
{
if (contentManagerID != this.Name)
throw this.GetLoadError(assetName, "can't load a different mod's managed asset key through this mod content manager.");
throw this.GetLoadError(assetName, ContentLoadErrorType.AccessDenied, "can't load a different mod's managed asset key through this mod content manager.");
assetName = relativePath;
}
}
@ -106,7 +106,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
// get file
FileInfo file = this.GetModFile<T>(assetName.Name);
if (!file.Exists)
throw this.GetLoadError(assetName, "the specified path doesn't exist.");
throw this.GetLoadError(assetName, ContentLoadErrorType.AssetDoesNotExist, "the specified path doesn't exist.");
// load content
asset = file.Extension.ToLower() switch
@ -121,7 +121,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
}
catch (Exception ex) when (ex is not SContentLoadException)
{
throw this.GetLoadError(assetName, "an unexpected occurred.", ex);
throw this.GetLoadError(assetName, ContentLoadErrorType.Other, "an unexpected occurred.", ex);
}
// track & return asset
@ -157,7 +157,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
{
// validate
if (!typeof(T).IsAssignableFrom(typeof(XmlSource)))
throw this.GetLoadError(assetName, $"can't read file with extension '{file.Extension}' as type '{typeof(T)}'; must be type '{typeof(XmlSource)}'.");
throw this.GetLoadError(assetName, ContentLoadErrorType.InvalidData, $"can't read file with extension '{file.Extension}' as type '{typeof(T)}'; must be type '{typeof(XmlSource)}'.");
// load
string source = File.ReadAllText(file.FullName);
@ -171,7 +171,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
private T LoadDataFile<T>(IAssetName assetName, FileInfo file)
{
if (!this.JsonHelper.ReadJsonFileIfExists(file.FullName, out T? asset))
throw this.GetLoadError(assetName, "the JSON file is invalid."); // should never happen since we check for file existence before calling this method
throw this.GetLoadError(assetName, ContentLoadErrorType.InvalidData, "the JSON file is invalid."); // should never happen since we check for file existence before calling this method
return asset;
}
@ -184,7 +184,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
{
// validate
if (typeof(T) != typeof(Texture2D))
throw this.GetLoadError(assetName, $"can't read file with extension '{file.Extension}' as type '{typeof(T)}'; must be type '{typeof(Texture2D)}'.");
throw this.GetLoadError(assetName, ContentLoadErrorType.InvalidData, $"can't read file with extension '{file.Extension}' as type '{typeof(T)}'; must be type '{typeof(Texture2D)}'.");
// load
using FileStream stream = File.OpenRead(file.FullName);
@ -201,7 +201,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
{
// validate
if (typeof(T) != typeof(Map))
throw this.GetLoadError(assetName, $"can't read file with extension '{file.Extension}' as type '{typeof(T)}'; must be type '{typeof(Map)}'.");
throw this.GetLoadError(assetName, ContentLoadErrorType.InvalidData, $"can't read file with extension '{file.Extension}' as type '{typeof(T)}'; must be type '{typeof(Map)}'.");
// load
FormatManager formatManager = FormatManager.Instance;
@ -239,16 +239,17 @@ namespace StardewModdingAPI.Framework.ContentManagers
/// <param name="file">The file to load.</param>
private T HandleUnknownFileType<T>(IAssetName assetName, FileInfo file)
{
throw this.GetLoadError(assetName, $"unknown file extension '{file.Extension}'; must be one of '.fnt', '.json', '.png', '.tbin', '.tmx', or '.xnb'.");
throw this.GetLoadError(assetName, ContentLoadErrorType.InvalidName, $"unknown file extension '{file.Extension}'; must be one of '.fnt', '.json', '.png', '.tbin', '.tmx', or '.xnb'.");
}
/// <summary>Get an error which indicates that an asset couldn't be loaded.</summary>
/// <param name="errorType">Why loading an asset through the content pipeline failed.</param>
/// <param name="assetName">The asset name that failed to load.</param>
/// <param name="reasonPhrase">The reason the file couldn't be loaded.</param>
/// <param name="exception">The underlying exception, if applicable.</param>
private SContentLoadException GetLoadError(IAssetName assetName, string reasonPhrase, Exception? exception = null)
private SContentLoadException GetLoadError(IAssetName assetName, ContentLoadErrorType errorType, string reasonPhrase, Exception? exception = null)
{
return new($"Failed loading asset '{assetName}' from {this.Name}: {reasonPhrase}", exception);
return new(errorType, $"Failed loading asset '{assetName}' from {this.Name}: {reasonPhrase}", exception);
}
/// <summary>Get a file from the mod folder.</summary>
@ -328,13 +329,13 @@ namespace StardewModdingAPI.Framework.ContentManagers
// validate tilesheet path
string errorPrefix = $"{this.ModName} loaded map '{relativeMapPath}' with invalid tilesheet path '{imageSource}'.";
if (Path.IsPathRooted(imageSource) || PathUtilities.GetSegments(imageSource).Contains(".."))
throw new SContentLoadException($"{errorPrefix} Tilesheet paths must be a relative path without directory climbing (../).");
throw new SContentLoadException(ContentLoadErrorType.InvalidData, $"{errorPrefix} Tilesheet paths must be a relative path without directory climbing (../).");
// load best match
try
{
if (!this.TryGetTilesheetAssetName(relativeMapFolder, imageSource, out IAssetName? assetName, out string? error))
throw new SContentLoadException($"{errorPrefix} {error}");
throw new SContentLoadException(ContentLoadErrorType.InvalidData, $"{errorPrefix} {error}");
if (assetName is not null)
{
@ -346,7 +347,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
}
catch (Exception ex) when (ex is not SContentLoadException)
{
throw new SContentLoadException($"{errorPrefix} The tilesheet couldn't be loaded.", ex);
throw new SContentLoadException(ContentLoadErrorType.InvalidData, $"{errorPrefix} The tilesheet couldn't be loaded.", ex);
}
}
}

21
src/SMAPI/Framework/Exceptions/ContentLoadErrorType.cs Normal file
View File

@ -0,0 +1,21 @@
namespace StardewModdingAPI.Framework.Exceptions
{
/// <summary>Indicates why loading an asset through the content pipeline failed.</summary>
internal enum ContentLoadErrorType
{
/// <summary>The asset name is empty or has an invalid format.</summary>
InvalidName,
/// <summary>The asset doesn't exist.</summary>
AssetDoesNotExist,
/// <summary>The asset is not available in the current context (e.g. an attempt to load another mod's assets).</summary>
AccessDenied,
/// <summary>The asset exists, but the data could not be deserialized or it doesn't match the expected type.</summary>
InvalidData,
/// <summary>An unknown error occurred.</summary>
Other
}
}

15
src/SMAPI/Framework/Exceptions/SContentLoadException.cs
View File

@ -6,13 +6,24 @@ namespace StardewModdingAPI.Framework.Exceptions
/// <summary>An implementation of <see cref="ContentLoadException"/> used by SMAPI to detect whether it was thrown by SMAPI or the underlying framework.</summary>
internal class SContentLoadException : ContentLoadException
{
/*********
** Accessors
*********/
/// <summary>Why loading the asset through the content pipeline failed.</summary>
public ContentLoadErrorType ErrorType { get; }
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="errorType">Why loading the asset through the content pipeline failed.</param>
/// <param name="message">The error message.</param>
/// <param name="ex">The underlying exception, if any.</param>
public SContentLoadException(string message, Exception? ex = null)
: base(message, ex) { }
public SContentLoadException(ContentLoadErrorType errorType, string message, Exception? ex = null)
: base(message, ex)
{
this.ErrorType = errorType;
}
}
}

4
src/SMAPI/Framework/ModHelpers/ContentHelper.cs
View File

@ -135,12 +135,12 @@ namespace StardewModdingAPI.Framework.ModHelpers
return this.ModContentManager.LoadExact<T>(assetName, useCache: false);
default:
throw new SContentLoadException($"{this.Mod.DisplayName} failed loading content asset '{key}' from {source}: unknown content source '{source}'.");
throw new SContentLoadException(ContentLoadErrorType.Other, $"{this.Mod.DisplayName} failed loading content asset '{key}' from {source}: unknown content source '{source}'.");
}
}
catch (Exception ex) when (ex is not SContentLoadException)
{
throw new SContentLoadException($"{this.Mod.DisplayName} failed loading content asset '{key}' from {source}.", ex);
throw new SContentLoadException(ContentLoadErrorType.Other, $"{this.Mod.DisplayName} failed loading content asset '{key}' from {source}.", ex);
}
}

2
src/SMAPI/Framework/ModHelpers/GameContentHelper.cs
View File

@ -85,7 +85,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
}
catch (Exception ex) when (ex is not SContentLoadException)
{
throw new SContentLoadException($"{this.ModName} failed loading content asset '{assetName}' from the game content.", ex);
throw new SContentLoadException(ContentLoadErrorType.Other, $"{this.ModName} failed loading content asset '{assetName}' from the game content.", ex);
}
}

2
src/SMAPI/Framework/ModHelpers/ModContentHelper.cs
View File

@ -58,7 +58,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
}
catch (Exception ex) when (ex is not SContentLoadException)
{
throw new SContentLoadException($"{this.ModName} failed loading content asset '{relativePath}' from its mod folder.", ex);
throw new SContentLoadException(ContentLoadErrorType.Other, $"{this.ModName} failed loading content asset '{relativePath}' from its mod folder.", ex);
}
}