mirror of
https://github.com/ryujinx-mirror/ryujinx.git
synced 2024-12-05 21:17:56 +01:00
db56b2166d
This PR implement `ApplicationErrorArg` to the Error Applet. It's used by the guest to throw some specific error messages. The code was done for (and merged) LDN2 build since long time ago and have been tested a bunch of times because of that! In a way to reduce the differences between LDN and master build it's fine to add it to master.
213 lines
8.5 KiB
C#
213 lines
8.5 KiB
C#
using LibHac.Common;
|
|
using LibHac.Fs;
|
|
using LibHac.Fs.Fsa;
|
|
using LibHac.FsSystem;
|
|
using LibHac.FsSystem.NcaUtils;
|
|
using Ryujinx.Common.Logging;
|
|
using Ryujinx.HLE.FileSystem;
|
|
using Ryujinx.HLE.HOS.Services.Am.AppletAE;
|
|
using Ryujinx.HLE.HOS.SystemState;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Runtime.InteropServices;
|
|
using System.Text;
|
|
using System.Text.RegularExpressions;
|
|
|
|
namespace Ryujinx.HLE.HOS.Applets.Error
|
|
{
|
|
internal class ErrorApplet : IApplet
|
|
{
|
|
private const long ErrorMessageBinaryTitleId = 0x0100000000000801;
|
|
|
|
private Horizon _horizon;
|
|
private AppletSession _normalSession;
|
|
private CommonArguments _commonArguments;
|
|
private ErrorCommonHeader _errorCommonHeader;
|
|
private byte[] _errorStorage;
|
|
|
|
public event EventHandler AppletStateChanged;
|
|
|
|
public ErrorApplet(Horizon horizon)
|
|
{
|
|
_horizon = horizon;
|
|
}
|
|
|
|
public ResultCode Start(AppletSession normalSession,
|
|
AppletSession interactiveSession)
|
|
{
|
|
_normalSession = normalSession;
|
|
_commonArguments = IApplet.ReadStruct<CommonArguments>(_normalSession.Pop());
|
|
|
|
Logger.Info?.PrintMsg(LogClass.ServiceAm, $"ErrorApplet version: 0x{_commonArguments.AppletVersion:x8}");
|
|
|
|
_errorStorage = _normalSession.Pop();
|
|
_errorCommonHeader = IApplet.ReadStruct<ErrorCommonHeader>(_errorStorage);
|
|
_errorStorage = _errorStorage.Skip(Marshal.SizeOf(typeof(ErrorCommonHeader))).ToArray();
|
|
|
|
switch (_errorCommonHeader.Type)
|
|
{
|
|
case ErrorType.ErrorCommonArg:
|
|
{
|
|
ParseErrorCommonArg();
|
|
|
|
break;
|
|
}
|
|
case ErrorType.ApplicationErrorArg:
|
|
{
|
|
ParseApplicationErrorArg();
|
|
|
|
break;
|
|
}
|
|
default: throw new NotImplementedException($"ErrorApplet type {_errorCommonHeader.Type} is not implemented.");
|
|
}
|
|
|
|
AppletStateChanged?.Invoke(this, null);
|
|
|
|
return ResultCode.Success;
|
|
}
|
|
|
|
private (uint module, uint description) HexToResultCode(uint resultCode)
|
|
{
|
|
return ((resultCode & 0x1FF) + 2000, (resultCode >> 9) & 0x3FFF);
|
|
}
|
|
|
|
private string SystemLanguageToLanguageKey(SystemLanguage systemLanguage)
|
|
{
|
|
return systemLanguage switch
|
|
{
|
|
SystemLanguage.Japanese => "ja",
|
|
SystemLanguage.AmericanEnglish => "en-US",
|
|
SystemLanguage.French => "fr",
|
|
SystemLanguage.German => "de",
|
|
SystemLanguage.Italian => "it",
|
|
SystemLanguage.Spanish => "es",
|
|
SystemLanguage.Chinese => "zh-Hans",
|
|
SystemLanguage.Korean => "ko",
|
|
SystemLanguage.Dutch => "nl",
|
|
SystemLanguage.Portuguese => "pt",
|
|
SystemLanguage.Russian => "ru",
|
|
SystemLanguage.Taiwanese => "zh-HansT",
|
|
SystemLanguage.BritishEnglish => "en-GB",
|
|
SystemLanguage.CanadianFrench => "fr-CA",
|
|
SystemLanguage.LatinAmericanSpanish => "es-419",
|
|
SystemLanguage.SimplifiedChinese => "zh-Hans",
|
|
SystemLanguage.TraditionalChinese => "zh-Hant",
|
|
_ => "en-US"
|
|
};
|
|
}
|
|
|
|
public string CleanText(string value)
|
|
{
|
|
return Regex.Replace(Encoding.Unicode.GetString(Encoding.UTF8.GetBytes(value)), @"[^\u0009\u000A\u000D\u0020-\u007E]", "");
|
|
}
|
|
|
|
private string GetMessageText(uint module, uint description, string key)
|
|
{
|
|
string binaryTitleContentPath = _horizon.ContentManager.GetInstalledContentPath(ErrorMessageBinaryTitleId, StorageId.NandSystem, NcaContentType.Data);
|
|
|
|
using (LibHac.Fs.IStorage ncaFileStream = new LocalStorage(_horizon.Device.FileSystem.SwitchPathToSystemPath(binaryTitleContentPath), FileAccess.Read, FileMode.Open))
|
|
{
|
|
Nca nca = new Nca(_horizon.Device.FileSystem.KeySet, ncaFileStream);
|
|
IFileSystem romfs = nca.OpenFileSystem(NcaSectionType.Data, _horizon.FsIntegrityCheckLevel);
|
|
string languageCode = SystemLanguageToLanguageKey(_horizon.State.DesiredSystemLanguage);
|
|
string filePath = "/" + Path.Combine(module.ToString(), $"{description:0000}", $"{languageCode}_{key}").Replace(@"\", "/");
|
|
|
|
if (romfs.FileExists(filePath))
|
|
{
|
|
romfs.OpenFile(out IFile binaryFile, filePath.ToU8Span(), OpenMode.Read).ThrowIfFailure();
|
|
|
|
StreamReader reader = new StreamReader(binaryFile.AsStream());
|
|
|
|
return CleanText(reader.ReadToEnd());
|
|
}
|
|
else
|
|
{
|
|
return "";
|
|
}
|
|
}
|
|
}
|
|
|
|
private string[] GetButtonsText(uint module, uint description, string key)
|
|
{
|
|
string buttonsText = GetMessageText(module, description, key);
|
|
|
|
return (buttonsText == "") ? null : buttonsText.Split(new[] { "\r\n", "\r", "\n" }, StringSplitOptions.None);
|
|
}
|
|
|
|
private void ParseErrorCommonArg()
|
|
{
|
|
ErrorCommonArg errorCommonArg = IApplet.ReadStruct<ErrorCommonArg>(_errorStorage);
|
|
|
|
uint module = errorCommonArg.Module;
|
|
uint description = errorCommonArg.Description;
|
|
|
|
if (_errorCommonHeader.MessageFlag == 0)
|
|
{
|
|
(module, description) = HexToResultCode(errorCommonArg.ResultCode);
|
|
}
|
|
|
|
string message = GetMessageText(module, description, "DlgMsg");
|
|
|
|
if (message == "")
|
|
{
|
|
message = "An error has occured.\n\n"
|
|
+ "Please try again later.\n\n"
|
|
+ "If the problem persists, please refer to the Ryujinx website.\n"
|
|
+ "www.ryujinx.org";
|
|
}
|
|
|
|
string[] buttons = GetButtonsText(module, description, "DlgBtn");
|
|
|
|
bool showDetails = _horizon.Device.UiHandler.DisplayErrorAppletDialog($"Error Code: {module}-{description:0000}", "\n" + message, buttons);
|
|
if (showDetails)
|
|
{
|
|
message = GetMessageText(module, description, "FlvMsg");
|
|
buttons = GetButtonsText(module, description, "FlvBtn");
|
|
|
|
_horizon.Device.UiHandler.DisplayErrorAppletDialog($"Details: {module}-{description:0000}", "\n" + message, buttons);
|
|
}
|
|
}
|
|
|
|
private void ParseApplicationErrorArg()
|
|
{
|
|
ApplicationErrorArg applicationErrorArg = IApplet.ReadStruct<ApplicationErrorArg>(_errorStorage);
|
|
|
|
byte[] messageTextBuffer = new byte[0x800];
|
|
byte[] detailsTextBuffer = new byte[0x800];
|
|
unsafe
|
|
{
|
|
Marshal.Copy((IntPtr)applicationErrorArg.MessageText, messageTextBuffer, 0, 0x800);
|
|
Marshal.Copy((IntPtr)applicationErrorArg.DetailsText, detailsTextBuffer, 0, 0x800);
|
|
}
|
|
|
|
string messageText = Encoding.ASCII.GetString(messageTextBuffer.TakeWhile(b => !b.Equals(0)).ToArray());
|
|
string detailsText = Encoding.ASCII.GetString(detailsTextBuffer.TakeWhile(b => !b.Equals(0)).ToArray());
|
|
|
|
List<string> buttons = new List<string>();
|
|
|
|
// TODO: Handle the LanguageCode to return the translated "OK" and "Details".
|
|
|
|
if (detailsText.Trim() != "")
|
|
{
|
|
buttons.Add("Details");
|
|
}
|
|
|
|
buttons.Add("OK");
|
|
|
|
bool showDetails = _horizon.Device.UiHandler.DisplayErrorAppletDialog($"Error Number: {applicationErrorArg.ErrorNumber}", "\n" + messageText, buttons.ToArray());
|
|
if (showDetails)
|
|
{
|
|
buttons.RemoveAt(0);
|
|
|
|
_horizon.Device.UiHandler.DisplayErrorAppletDialog($"Error Number: {applicationErrorArg.ErrorNumber} (Details)", "\n" + detailsText, buttons.ToArray());
|
|
}
|
|
}
|
|
|
|
public ResultCode GetResult()
|
|
{
|
|
return ResultCode.Success;
|
|
}
|
|
}
|
|
} |