From 2e6080ccbb1598fc13d0f68b3d05dd4f416bb0b0 Mon Sep 17 00:00:00 2001 From: Xpl0itR Date: Sat, 8 Feb 2020 18:22:45 +0000 Subject: [PATCH] Implement NCA section extractors in the GUI (#896) * Implement NCA section extractors in the GUI * AcK's requested changes * Put extractor on a new thread and added dialogs * bug fix * make extraction cancelable * nits * changes * gdkchan's requested change --- Ryujinx/Ui/GameTableContextMenu.cs | 322 ++++++++++++++++++++++++-- Ryujinx/Ui/GameTableContextMenu.glade | 30 +++ 2 files changed, 330 insertions(+), 22 deletions(-) diff --git a/Ryujinx/Ui/GameTableContextMenu.cs b/Ryujinx/Ui/GameTableContextMenu.cs index 196799ead..3fbc985a6 100644 --- a/Ryujinx/Ui/GameTableContextMenu.cs +++ b/Ryujinx/Ui/GameTableContextMenu.cs @@ -1,14 +1,20 @@ using Gtk; using LibHac; +using LibHac.Common; using LibHac.Fs; using LibHac.Fs.Shim; +using LibHac.FsSystem; +using LibHac.FsSystem.NcaUtils; using LibHac.Ncm; +using Ryujinx.Common.Logging; using Ryujinx.HLE.FileSystem; using System; +using System.Buffers; using System.Diagnostics; using System.Globalization; using System.IO; using System.Reflection; +using System.Threading; using GUI = Gtk.Builder.ObjectAttribute; @@ -16,13 +22,18 @@ namespace Ryujinx.Ui { public class GameTableContextMenu : Menu { - private static ListStore _gameTableStore; - private static TreeIter _rowIter; + private ListStore _gameTableStore; + private TreeIter _rowIter; private VirtualFileSystem _virtualFileSystem; + private MessageDialog _dialog; + private bool _cancel; #pragma warning disable CS0649 #pragma warning disable IDE0044 [GUI] MenuItem _openSaveDir; + [GUI] MenuItem _extractRomFs; + [GUI] MenuItem _extractExeFs; + [GUI] MenuItem _extractLogo; #pragma warning restore CS0649 #pragma warning restore IDE0044 @@ -33,32 +44,22 @@ namespace Ryujinx.Ui { builder.Autoconnect(this); - _openSaveDir.Activated += OpenSaveDir_Clicked; + _openSaveDir.Activated += OpenSaveDir_Clicked; + _extractRomFs.Activated += ExtractRomFs_Clicked; + _extractExeFs.Activated += ExtractExeFs_Clicked; + _extractLogo.Activated += ExtractLogo_Clicked; _gameTableStore = gameTableStore; _rowIter = rowIter; _virtualFileSystem = virtualFileSystem; - } - //Events - private void OpenSaveDir_Clicked(object sender, EventArgs args) - { - string titleName = _gameTableStore.GetValue(_rowIter, 2).ToString().Split("\n")[0]; - string titleId = _gameTableStore.GetValue(_rowIter, 2).ToString().Split("\n")[1].ToLower(); - - if (!TryFindSaveData(titleName, titleId, out ulong saveDataId)) + string ext = System.IO.Path.GetExtension(_gameTableStore.GetValue(_rowIter, 9).ToString()).ToLower(); + if (ext != ".nca" && ext != ".nsp" && ext != ".pfs0" && ext != ".xci") { - return; + _extractRomFs.Sensitive = false; + _extractExeFs.Sensitive = false; + _extractLogo.Sensitive = false; } - - string saveDir = GetSaveDataDirectory(saveDataId); - - Process.Start(new ProcessStartInfo() - { - FileName = saveDir, - UseShellExecute = true, - Verb = "open" - }); } private bool TryFindSaveData(string titleName, string titleIdText, out ulong saveDataId) @@ -131,7 +132,7 @@ namespace Ryujinx.Ui } string committedPath = System.IO.Path.Combine(saveRootPath, "0"); - string workingPath = System.IO.Path.Combine(saveRootPath, "1"); + string workingPath = System.IO.Path.Combine(saveRootPath, "1"); // If the committed directory exists, that path will be loaded the next time the savedata is mounted if (Directory.Exists(committedPath)) @@ -148,5 +149,282 @@ namespace Ryujinx.Ui return workingPath; } + + private void ExtractSection(NcaSectionType ncaSectionType) + { + FileChooserDialog fileChooser = new FileChooserDialog("Choose the folder to extract into", null, FileChooserAction.SelectFolder, "Cancel", ResponseType.Cancel, "Extract", ResponseType.Accept); + fileChooser.SetPosition(WindowPosition.Center); + + int response = fileChooser.Run(); + string destination = fileChooser.Filename; + + fileChooser.Dispose(); + + if (response == (int)ResponseType.Accept) + { + Thread extractorThread = new Thread(() => + { + string sourceFile = _gameTableStore.GetValue(_rowIter, 9).ToString(); + + Gtk.Application.Invoke(delegate + { + _dialog = new MessageDialog(null, DialogFlags.DestroyWithParent, MessageType.Info, ButtonsType.Cancel, null) + { + Title = "Ryujinx - NCA Section Extractor", + Icon = new Gdk.Pixbuf(Assembly.GetExecutingAssembly(), "Ryujinx.Ui.assets.Icon.png"), + SecondaryText = $"Extracting {ncaSectionType} section from {System.IO.Path.GetFileName(sourceFile)}...", + WindowPosition = WindowPosition.Center + }; + + int dialogResponse = _dialog.Run(); + if (dialogResponse == (int)ResponseType.Cancel || dialogResponse == (int)ResponseType.DeleteEvent) + { + _cancel = true; + _dialog.Dispose(); + } + }); + + using (FileStream file = new FileStream(sourceFile, FileMode.Open, FileAccess.Read)) + { + Nca mainNca = null; + Nca patchNca = null; + + if ((System.IO.Path.GetExtension(sourceFile).ToLower() == ".nsp") || + (System.IO.Path.GetExtension(sourceFile).ToLower() == ".pfs0") || + (System.IO.Path.GetExtension(sourceFile).ToLower() == ".xci")) + { + PartitionFileSystem pfs; + + if (System.IO.Path.GetExtension(sourceFile) == ".xci") + { + Xci xci = new Xci(_virtualFileSystem.KeySet, file.AsStorage()); + + pfs = xci.OpenPartition(XciPartitionType.Secure); + } + else + { + pfs = new PartitionFileSystem(file.AsStorage()); + } + + foreach (DirectoryEntryEx fileEntry in pfs.EnumerateEntries("/", "*.nca")) + { + pfs.OpenFile(out IFile ncaFile, fileEntry.FullPath, OpenMode.Read).ThrowIfFailure(); + + Nca nca = new Nca(_virtualFileSystem.KeySet, ncaFile.AsStorage()); + + if (nca.Header.ContentType == NcaContentType.Program) + { + int dataIndex = Nca.GetSectionIndexFromType(NcaSectionType.Data, NcaContentType.Program); + + if (nca.Header.GetFsHeader(dataIndex).IsPatchSection()) + { + patchNca = nca; + } + else + { + mainNca = nca; + } + } + } + } + else if (System.IO.Path.GetExtension(sourceFile).ToLower() == ".nca") + { + mainNca = new Nca(_virtualFileSystem.KeySet, file.AsStorage()); + } + + if (mainNca == null) + { + Logger.PrintError(LogClass.Application, "Extraction failed. The main NCA was not present in the selected file."); + + Gtk.Application.Invoke(delegate + { + GtkDialog.CreateErrorDialog("Extraction failed. The main NCA was not present in the selected file."); + }); + + return; + } + + int index = Nca.GetSectionIndexFromType(ncaSectionType, mainNca.Header.ContentType); + + IFileSystem ncaFileSystem = patchNca != null ? mainNca.OpenFileSystemWithPatch(patchNca, index, IntegrityCheckLevel.ErrorOnInvalid) + : mainNca.OpenFileSystem(index, IntegrityCheckLevel.ErrorOnInvalid); + + FileSystemClient fsClient = _virtualFileSystem.FsClient; + + string source = DateTime.Now.ToFileTime().ToString().Substring(10); + string output = DateTime.Now.ToFileTime().ToString().Substring(10); + + fsClient.Register(source.ToU8Span(), ncaFileSystem); + fsClient.Register(output.ToU8Span(), new LocalFileSystem(destination)); + + (Result? resultCode, bool canceled) = CopyDirectory(fsClient, $"{source}:/", $"{output}:/"); + + if (!canceled) + { + if (resultCode.Value.IsFailure()) + { + Logger.PrintError(LogClass.Application, $"LibHac returned error code: {resultCode.Value.ErrorCode}"); + + Gtk.Application.Invoke(delegate + { + _dialog?.Dispose(); + + GtkDialog.CreateErrorDialog("Extraction failed. Read the log file for further information."); + }); + } + else if (resultCode.Value.IsSuccess()) + { + Gtk.Application.Invoke(delegate + { + _dialog?.Dispose(); + + MessageDialog dialog = new MessageDialog(null, DialogFlags.DestroyWithParent, MessageType.Info, ButtonsType.Ok, null) + { + Title = "Ryujinx - NCA Section Extractor", + Icon = new Gdk.Pixbuf(Assembly.GetExecutingAssembly(), "Ryujinx.Ui.assets.Icon.png"), + SecondaryText = "Extraction has completed successfully.", + WindowPosition = WindowPosition.Center + }; + + dialog.Run(); + dialog.Dispose(); + }); + } + } + + fsClient.Unmount(source); + fsClient.Unmount(output); + } + }); + + extractorThread.Name = "GUI.NcaSectionExtractorThread"; + extractorThread.IsBackground = true; + extractorThread.Start(); + } + } + + private (Result? result, bool canceled) CopyDirectory(FileSystemClient fs, string sourcePath, string destPath) + { + Result rc = fs.OpenDirectory(out DirectoryHandle sourceHandle, sourcePath, OpenDirectoryMode.All); + if (rc.IsFailure()) return (rc, false); + + using (sourceHandle) + { + foreach (DirectoryEntryEx entry in fs.EnumerateEntries(sourcePath, "*", SearchOptions.Default)) + { + if (_cancel) + { + return (null, true); + } + + string subSrcPath = PathTools.Normalize(PathTools.Combine(sourcePath, entry.Name)); + string subDstPath = PathTools.Normalize(PathTools.Combine(destPath, entry.Name)); + + if (entry.Type == DirectoryEntryType.Directory) + { + fs.EnsureDirectoryExists(subDstPath); + + (Result? result, bool canceled) = CopyDirectory(fs, subSrcPath, subDstPath); + if (canceled || result.Value.IsFailure()) + { + return (result, canceled); + } + } + + if (entry.Type == DirectoryEntryType.File) + { + fs.CreateOrOverwriteFile(subDstPath, entry.Size); + + rc = CopyFile(fs, subSrcPath, subDstPath); + if (rc.IsFailure()) return (rc, false); + } + } + } + + return (Result.Success, false); + } + + public Result CopyFile(FileSystemClient fs, string sourcePath, string destPath) + { + Result rc = fs.OpenFile(out FileHandle sourceHandle, sourcePath, OpenMode.Read); + if (rc.IsFailure()) return rc; + + using (sourceHandle) + { + rc = fs.OpenFile(out FileHandle destHandle, destPath, OpenMode.Write | OpenMode.AllowAppend); + if (rc.IsFailure()) return rc; + + using (destHandle) + { + const int maxBufferSize = 1024 * 1024; + + rc = fs.GetFileSize(out long fileSize, sourceHandle); + if (rc.IsFailure()) return rc; + + int bufferSize = (int)Math.Min(maxBufferSize, fileSize); + + byte[] buffer = ArrayPool.Shared.Rent(bufferSize); + try + { + for (long offset = 0; offset < fileSize; offset += bufferSize) + { + int toRead = (int)Math.Min(fileSize - offset, bufferSize); + Span buf = buffer.AsSpan(0, toRead); + + rc = fs.ReadFile(out long _, sourceHandle, offset, buf); + if (rc.IsFailure()) return rc; + + rc = fs.WriteFile(destHandle, offset, buf); + if (rc.IsFailure()) return rc; + } + } + finally + { + ArrayPool.Shared.Return(buffer); + } + + rc = fs.FlushFile(destHandle); + if (rc.IsFailure()) return rc; + } + } + + return Result.Success; + } + + // Events + private void OpenSaveDir_Clicked(object sender, EventArgs args) + { + string titleName = _gameTableStore.GetValue(_rowIter, 2).ToString().Split("\n")[0]; + string titleId = _gameTableStore.GetValue(_rowIter, 2).ToString().Split("\n")[1].ToLower(); + + if (!TryFindSaveData(titleName, titleId, out ulong saveDataId)) + { + return; + } + + string saveDir = GetSaveDataDirectory(saveDataId); + + Process.Start(new ProcessStartInfo() + { + FileName = saveDir, + UseShellExecute = true, + Verb = "open" + }); + } + + private void ExtractRomFs_Clicked(object sender, EventArgs args) + { + ExtractSection(NcaSectionType.Data); + } + + private void ExtractExeFs_Clicked(object sender, EventArgs args) + { + ExtractSection(NcaSectionType.Code); + } + + private void ExtractLogo_Clicked(object sender, EventArgs args) + { + ExtractSection(NcaSectionType.Logo); + } } } diff --git a/Ryujinx/Ui/GameTableContextMenu.glade b/Ryujinx/Ui/GameTableContextMenu.glade index 2c9e09729..13bade4e5 100644 --- a/Ryujinx/Ui/GameTableContextMenu.glade +++ b/Ryujinx/Ui/GameTableContextMenu.glade @@ -14,5 +14,35 @@ True + + + True + False + + + + + True + False + Extract RomFS Section + True + + + + + True + False + Extract ExeFS Section + True + + + + +