1
0
Fork 0
mirror of https://github.com/DarkMatterCore/nxdumptool.git synced 2024-12-28 19:36:03 +00:00
nxdumptool/source/core/title.c
2021-06-18 01:34:02 -04:00

2537 lines
95 KiB
C

/*
* title.c
*
* Copyright (c) 2020-2021, DarkMatterCore <pabloacurielz@gmail.com>.
*
* This file is part of nxdumptool (https://github.com/DarkMatterCore/nxdumptool).
*
* nxdumptool is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* nxdumptool is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "nxdt_utils.h"
#include "title.h"
#include "gamecard.h"
#include "nacp.h"
#define NS_APPLICATION_RECORD_LIMIT 4096
#define TITLE_STORAGE_COUNT 4 /* GameCard, BuiltInSystem, BuiltInUser, SdCard. */
#define TITLE_STORAGE_INDEX(storage_id) ((storage_id) - NcmStorageId_GameCard)
/* Type definitions. */
typedef struct {
u64 title_id;
char name[32];
} TitleSystemEntry;
typedef struct {
u8 storage_id; ///< NcmStorageId.
NcmContentMetaDatabase ncm_db;
NcmContentStorage ncm_storage;
TitleInfo **titles;
u32 title_count;
} TitleStorage;
/* Global variables. */
static Mutex g_titleMutex = 0;
static Thread g_titleGameCardInfoThread = {0};
static UEvent g_titleGameCardInfoThreadExitEvent = {0}, *g_titleGameCardStatusChangeUserEvent = NULL;
static bool g_titleInterfaceInit = false, g_titleGameCardInfoThreadCreated = false, g_titleGameCardAvailable = false, g_titleGameCardInfoUpdated = false;
static NsApplicationControlData *g_nsAppControlData = NULL;
static TitleApplicationMetadata **g_systemMetadata = NULL, **g_userMetadata = NULL;
static u32 g_systemMetadataCount = 0, g_userMetadataCount = 0;
static TitleStorage g_titleStorage[TITLE_STORAGE_COUNT] = {0};
static TitleInfo **g_orphanTitleInfo = NULL;
static u32 g_orphanTitleInfoCount = 0;
static const char *g_titleNcmContentTypeNames[] = {
[NcmContentType_Meta] = "Meta",
[NcmContentType_Program] = "Program",
[NcmContentType_Data] = "Data",
[NcmContentType_Control] = "Control",
[NcmContentType_HtmlDocument] = "HtmlDocument",
[NcmContentType_LegalInformation] = "LegalInformation",
[NcmContentType_DeltaFragment] = "DeltaFragment"
};
static const char *g_titleNcmContentMetaTypeNames[] = {
[NcmContentMetaType_Unknown] = "Unknown",
[NcmContentMetaType_SystemProgram] = "SystemProgram",
[NcmContentMetaType_SystemData] = "SystemData",
[NcmContentMetaType_SystemUpdate] = "SystemUpdate",
[NcmContentMetaType_BootImagePackage] = "BootImagePackage",
[NcmContentMetaType_BootImagePackageSafe] = "BootImagePackageSafe",
[NcmContentMetaType_Application - 0x7A] = "Application",
[NcmContentMetaType_Patch - 0x7A] = "Patch",
[NcmContentMetaType_AddOnContent - 0x7A] = "AddOnContent",
[NcmContentMetaType_Delta - 0x7A] = "Delta"
};
static const char *g_filenameTypeStrings[] = {
[NcmContentMetaType_Application - 0x80] = "BASE",
[NcmContentMetaType_Patch - 0x80] = "UPD",
[NcmContentMetaType_AddOnContent - 0x80] = "DLC",
[NcmContentMetaType_Delta - 0x80] = "DELTA"
};
/* Info retrieved from https://switchbrew.org/wiki/Title_list. */
/* Titles bundled with the kernel are excluded. */
static const TitleSystemEntry g_systemTitles[] = {
/* System modules. */
/* Meta + Program NCAs. */
{ 0x0100000000000000, "fs" }, ///< Unused, bundled with kernel.
{ 0x0100000000000001, "ldr" }, ///< Unused, bundled with kernel.
{ 0x0100000000000002, "ncm" }, ///< Unused, bundled with kernel.
{ 0x0100000000000003, "pm" }, ///< Unused, bundled with kernel.
{ 0x0100000000000004, "sm" }, ///< Unused, bundled with kernel.
{ 0x0100000000000005, "boot" }, ///< Unused, bundled with kernel.
{ 0x0100000000000006, "usb" },
{ 0x0100000000000007, "htc" },
{ 0x0100000000000008, "boot2" },
{ 0x0100000000000009, "settings" },
{ 0x010000000000000A, "bus" },
{ 0x010000000000000B, "bluetooth" },
{ 0x010000000000000C, "bcat" },
{ 0x010000000000000D, "dmnt" },
{ 0x010000000000000E, "friends" },
{ 0x010000000000000F, "nifm" },
{ 0x0100000000000010, "ptm" },
{ 0x0100000000000011, "shell" },
{ 0x0100000000000012, "bsdsockets" },
{ 0x0100000000000013, "hid" },
{ 0x0100000000000014, "audio" },
{ 0x0100000000000015, "LogManager" },
{ 0x0100000000000016, "wlan" },
{ 0x0100000000000017, "cs" },
{ 0x0100000000000018, "ldn" },
{ 0x0100000000000019, "nvservices" },
{ 0x010000000000001A, "pcv" },
{ 0x010000000000001B, "capmtp" },
{ 0x010000000000001C, "nvnflinger" },
{ 0x010000000000001D, "pcie" },
{ 0x010000000000001E, "account" },
{ 0x010000000000001F, "ns" },
{ 0x0100000000000020, "nfc" },
{ 0x0100000000000021, "psc" },
{ 0x0100000000000022, "capsrv" },
{ 0x0100000000000023, "am" },
{ 0x0100000000000024, "ssl" },
{ 0x0100000000000025, "nim" },
{ 0x0100000000000026, "cec" },
{ 0x0100000000000027, "tspm" },
{ 0x0100000000000028, "spl" }, ///< Unused, bundled with kernel.
{ 0x0100000000000029, "lbl" },
{ 0x010000000000002A, "btm" },
{ 0x010000000000002B, "erpt" },
{ 0x010000000000002C, "time" },
{ 0x010000000000002D, "vi" },
{ 0x010000000000002E, "pctl" },
{ 0x010000000000002F, "npns" },
{ 0x0100000000000030, "eupld" },
{ 0x0100000000000031, "glue" },
{ 0x0100000000000032, "eclct" },
{ 0x0100000000000033, "es" },
{ 0x0100000000000034, "fatal" },
{ 0x0100000000000035, "grc" },
{ 0x0100000000000036, "creport" },
{ 0x0100000000000037, "ro" },
{ 0x0100000000000038, "profiler" },
{ 0x0100000000000039, "sdb" },
{ 0x010000000000003A, "migration" },
{ 0x010000000000003B, "jit" },
{ 0x010000000000003C, "jpegdec" },
{ 0x010000000000003D, "safemode" },
{ 0x010000000000003E, "olsc" },
{ 0x010000000000003F, "dt" },
{ 0x0100000000000040, "nd" },
{ 0x0100000000000041, "ngct" },
{ 0x0100000000000042, "pgl" },
/* System data archives. */
/* Meta + Data NCAs. */
{ 0x0100000000000800, "CertStore" },
{ 0x0100000000000801, "ErrorMessage" },
{ 0x0100000000000802, "MiiModel" },
{ 0x0100000000000803, "BrowserDll" },
{ 0x0100000000000804, "Help" },
{ 0x0100000000000805, "SharedFont" },
{ 0x0100000000000806, "NgWord" },
{ 0x0100000000000807, "SsidList" },
{ 0x0100000000000808, "Dictionary" },
{ 0x0100000000000809, "SystemVersion" },
{ 0x010000000000080A, "AvatarImage" },
{ 0x010000000000080B, "LocalNews" },
{ 0x010000000000080C, "Eula" },
{ 0x010000000000080D, "UrlBlackList" },
{ 0x010000000000080E, "TimeZoneBinary" },
{ 0x010000000000080F, "CertStoreCruiser" },
{ 0x0100000000000810, "FontNintendoExtension" },
{ 0x0100000000000811, "FontStandard" },
{ 0x0100000000000812, "FontKorean" },
{ 0x0100000000000813, "FontChineseTraditional" },
{ 0x0100000000000814, "FontChineseSimple" },
{ 0x0100000000000815, "FontBfcpx" },
{ 0x0100000000000816, "SystemUpdate" },
{ 0x0100000000000818, "FirmwareDebugSettings" },
{ 0x0100000000000819, "BootImagePackage" },
{ 0x010000000000081A, "BootImagePackageSafe" },
{ 0x010000000000081B, "BootImagePackageExFat" },
{ 0x010000000000081C, "BootImagePackageExFatSafe" },
{ 0x010000000000081D, "FatalMessage" },
{ 0x010000000000081E, "ControllerIcon" },
{ 0x010000000000081F, "PlatformConfigIcosa" },
{ 0x0100000000000820, "PlatformConfigCopper" },
{ 0x0100000000000821, "PlatformConfigHoag" },
{ 0x0100000000000822, "ControllerFirmware" },
{ 0x0100000000000823, "NgWord2" },
{ 0x0100000000000824, "PlatformConfigIcosaMariko" },
{ 0x0100000000000825, "ApplicationBlackList" },
{ 0x0100000000000826, "RebootlessSystemUpdateVersion" },
{ 0x0100000000000827, "ContentActionTable" },
{ 0x0100000000000828, "FunctionBlackList" },
{ 0x0100000000000829, "PlatformConfigCalcio" },
{ 0x0100000000000830, "NgWordT" },
{ 0x0100000000000831, "PlatformConfigAula" },
{ 0x0100000000000832, "CradleFirmwareAula" }, ///< Placeholder.
/* System applets. */
/* Meta + Program NCAs. */
{ 0x0100000000001000, "qlaunch" },
{ 0x0100000000001001, "auth" },
{ 0x0100000000001002, "cabinet" },
{ 0x0100000000001003, "controller" },
{ 0x0100000000001004, "dataErase" },
{ 0x0100000000001005, "error" },
{ 0x0100000000001006, "netConnect" },
{ 0x0100000000001007, "playerSelect" },
{ 0x0100000000001008, "swkbd" },
{ 0x0100000000001009, "miiEdit" },
{ 0x010000000000100A, "web" },
{ 0x010000000000100B, "shop" },
{ 0x010000000000100C, "overlayDisp" },
{ 0x010000000000100D, "photoViewer" },
{ 0x010000000000100E, "set" },
{ 0x010000000000100F, "offlineWeb" },
{ 0x0100000000001010, "loginShare" },
{ 0x0100000000001011, "wifiWebAuth" },
{ 0x0100000000001012, "starter" },
{ 0x0100000000001013, "myPage" },
{ 0x0100000000001014, "PlayReport" },
{ 0x0100000000001015, "MaintenanceMenu" },
{ 0x0100000000001016, "application_install" }, ///< Placeholder.
{ 0x0100000000001018, "systemupdate_dl_throughput" }, ///< Placeholder.
{ 0x0100000000001019, "volume_update"}, ///< Placeholder.
{ 0x010000000000101A, "gift" },
{ 0x010000000000101B, "DummyECApplet" },
{ 0x010000000000101C, "userMigration" },
{ 0x010000000000101D, "EncounterSys" },
{ 0x010000000000101E, "pearljam" }, ///< Placeholder.
{ 0x010000000000101F, "nim_glue_unknown" }, ///< Placeholder.
{ 0x0100000000001020, "story" },
{ 0x0100000000001021, "systemupdate_pass" }, ///< Placeholder.
{ 0x0100000000001023, "statistics" },
{ 0x0100000000001024, "syslog" },
{ 0x0100000000001025, "am_unknown_1" }, ///< Placeholder.
{ 0x0100000000001026, "olsc_unknown" }, ///< Placeholder.
{ 0x0100000000001027, "account_unknown" }, ///< Placeholder.
{ 0x0100000000001028, "ns_unknown_1" }, ///< Placeholder.
{ 0x010000000000102A, "am_unknown_2" }, ///< Placeholder.
{ 0x010000000000102B, "glue_unknown_1" }, ///< Placeholder.
{ 0x010000000000102E, "blacklist" },
{ 0x010000000000102F, "content_delivery" },
{ 0x0100000000001031, "ns_unknown_2" }, ///< Placeholder.
{ 0x0100000000001032, "glue_unknown_2" }, ///< Placeholder.
{ 0x0100000000001033, "promotion" },
{ 0x0100000000001034, "ngct_unknown" }, ///< Placeholder.
{ 0x0100000000001037, "nim_unknown" }, ///< Placeholder.
{ 0x0100000000001038, "sample" },
{ 0x0100000000001FFF, "EndOceanProgramId" },
/* Development system applets. */
{ 0x0100000000002000, "A2BoardFunction" },
{ 0x0100000000002001, "A3Wireless" },
{ 0x0100000000002002, "C1LcdAndKey" },
{ 0x0100000000002003, "C2UsbHpmic" },
{ 0x0100000000002004, "C3Aging" },
{ 0x0100000000002005, "C4SixAxis" },
{ 0x0100000000002006, "C5Wireless" },
{ 0x0100000000002007, "C7FinalCheck" },
{ 0x010000000000203F, "AutoCapture" },
{ 0x0100000000002040, "DevMenuCommandSystem" },
{ 0x0100000000002041, "recovery" },
{ 0x0100000000002042, "DevMenuSystem" },
{ 0x0100000000002044, "HB-TBIntegrationTest" },
{ 0x010000000000204D, "BackupSaveData" },
{ 0x010000000000204E, "A4BoardCalWriti" },
{ 0x0100000000002054, "RepairSslCertificate" },
{ 0x0100000000002055, "GameCardWriter" },
{ 0x0100000000002056, "UsbPdTestTool" },
{ 0x0100000000002057, "RepairDeletePctl" },
{ 0x0100000000002058, "RepairBackup" },
{ 0x0100000000002059, "RepairRestore" },
{ 0x010000000000205A, "RepairAccountTransfer" },
{ 0x010000000000205B, "RepairAutoNetworkUpdater" },
{ 0x010000000000205C, "RefurbishReset" },
{ 0x010000000000205D, "RepairAssistCup" },
{ 0x010000000000205E, "RepairPairingCutter" },
{ 0x0100000000002064, "DevMenu" },
{ 0x0100000000002065, "DevMenuApp" },
{ 0x0100000000002066, "GetGameCardAsicInfo" },
{ 0x0100000000002068, "NfpDebugToolSystem" },
{ 0x0100000000002069, "AlbumSynchronizer" },
{ 0x0100000000002071, "SnapShotDumper" },
{ 0x0100000000002073, "DevMenuSystemApp" },
{ 0x0100000000002099, "DevOverlayDisp" },
{ 0x010000000000209A, "NandVerifier" },
{ 0x010000000000209B, "GpuCoreDumper" },
{ 0x010000000000209C, "TestApplication" },
{ 0x010000000000209E, "HelloWorld" },
{ 0x01000000000020A0, "XcieWriter" },
{ 0x01000000000020A1, "GpuOverrunNotifier" },
{ 0x01000000000020C8, "NfpDebugTool" },
{ 0x01000000000020CA, "NoftWriter" },
{ 0x01000000000020D0, "BcatSystemDebugTool" },
{ 0x01000000000020D1, "DevSafeModeUpdater" },
{ 0x01000000000020D3, "ControllerConnectionAnalyzer" },
{ 0x01000000000020D4, "DevKitUpdater" },
{ 0x01000000000020D6, "RepairTimeReviser" },
{ 0x01000000000020D7, "RepairReinitializeFuelGauge" },
{ 0x01000000000020DA, "RepairAbortMigration" },
{ 0x01000000000020DC, "RepairShowDeviceId" },
{ 0x01000000000020DD, "RepairSetCycleCountReliability" },
{ 0x01000000000020E0, "Interface" },
{ 0x01000000000020E1, "AlbumDownloader" },
{ 0x01000000000020E3, "FuelGaugeDumper" },
{ 0x01000000000020E4, "UnsafeExtract" },
{ 0x01000000000020E5, "UnsafeEngrave" },
{ 0x01000000000020EE, "BluetoothSettingTool" },
{ 0x01000000000020F0, "ApplicationInstallerRomfs" },
{ 0x0100000000002100, "DevMenuLotcheckDownloader" },
{ 0x0100000000002101, "DevMenuCommand" },
{ 0x0100000000002102, "ExportPartition" },
{ 0x0100000000002103, "SystemInitializer" },
{ 0x0100000000002104, "SystemUpdaterHostFs" },
{ 0x0100000000002105, "WriteToStorage" },
{ 0x0100000000002106, "CalWriter" },
{ 0x0100000000002107, "SettingsManager" },
{ 0x0100000000002109, "testBuildSystemIris" },
{ 0x010000000000210A, "SystemUpdater" },
{ 0x010000000000210B, "nvnflinger_util" },
{ 0x010000000000210C, "ControllerFirmwareUpdater" },
{ 0x010000000000210D, "testBuildSystemNintendoWare" },
{ 0x0100000000002110, "TestSaveDataCreator" },
{ 0x0100000000002111, "C9LcdSpker" },
{ 0x0100000000002114, "RankTurn" },
{ 0x0100000000002116, "BleTestTool" },
{ 0x010000000000211A, "PreinstallAppWriter" },
{ 0x010000000000211C, "ControllerSerialFlashTool" },
{ 0x010000000000211D, "ControllerFlashWriter" },
{ 0x0100000000002120, "ControllerTestApp" },
{ 0x0100000000002121, "HidInspectionTool" },
{ 0x0100000000002124, "BatteryCyclesEditor" },
{ 0x0100000000002125, "UsbFirmwareUpdater" },
{ 0x0100000000002126, "PalmaSerialCodeTool" },
{ 0x0100000000002127, "renderdoccmd" },
{ 0x0100000000002128, "HidInspectionToolProd" },
{ 0x010000000000212C, "ExhibitionMenu" },
{ 0x010000000000212F, "ExhibitionSaveData" },
{ 0x0100000000002130, "LuciaConverter" },
{ 0x0100000000002133, "CalDumper" },
{ 0x0100000000002134, "AnalogStickEvaluationTool" },
{ 0x010000000000216D, "ExhibitionSaveDataSnapshot" }, ///< Placeholder.
{ 0x0100000000002178, "SecureStartupSettings" }, ///< Placeholder.
/* Debug system modules. */
{ 0x0100000000003002, "DummyProcess" },
{ 0x0100000000003003, "DebugMonitor0" },
{ 0x0100000000003004, "SystemHelloWorld" },
/* Development system modules. */
{ 0x010000000000B120, "nvdbgsvc" },
{ 0x010000000000B14A, "manu" },
{ 0x010000000000B14B, "ManuUsbLoopBack" },
{ 0x010000000000B1B8, "DevFwdbgHbPackage" },
{ 0x010000000000B1B9, "DevFwdbgUsbPackage" },
{ 0x010000000000B1BA, "ProdFwdbgPackage" },
{ 0x010000000000B22A, "scs" },
{ 0x010000000000B22B, "ControllerFirmwareDebug" },
{ 0x010000000000B240, "htc" },
/* Bdk system modules. */
{ 0x010000000000C600, "BdkSample01" },
{ 0x010000000000C601, "BdkSample02" },
{ 0x010000000000C602, "BdkSample03" },
{ 0x010000000000C603, "BdkSample04" },
/* Micro system modules. */
{ 0x010000000000D609, "dmnt.gen2" },
{ 0x010000000000D60A, "msm_unknown_1" }, ///< Placeholder.
{ 0x010000000000D60B, "msm_unknown_3" }, ///< Placeholder.
{ 0x010000000000D60C, "msm_unknown_3" }, ///< Placeholder.
{ 0x010000000000D60D, "msm_unknown_4" }, ///< Placeholder.
{ 0x010000000000D60E, "msm_unknown_5" }, ///< Placeholder.
{ 0x010000000000D610, "msm_unknown_6" }, ///< Placeholder.
{ 0x010000000000D611, "msm_unknown_7" }, ///< Placeholder.
{ 0x010000000000D612, "msm_unknown_8" }, ///< Placeholder.
{ 0x010000000000D613, "msm_unknown_9" }, ///< Placeholder.
{ 0x010000000000D614, "msm_unknown_10" }, ///< Placeholder.
{ 0x010000000000D615, "msm_unknown_11" }, ///< Placeholder.
{ 0x010000000000D616, "msm_unknown_12" }, ///< Placeholder.
{ 0x010000000000D617, "msm_unknown_13" }, ///< Placeholder.
{ 0x010000000000D619, "msm_unknown_14" }, ///< Placeholder.
{ 0x010000000000D623, "DevServer" },
/* System applications. */
{ 0x01008BB00013C000, "flog" },
{ 0x0100069000078000, "RetailInteractiveDisplayMenu" },
{ 0x010000B003486000, "AudioUsbMicDebugTool" },
{ 0x0100458001E04000, "BcatTestApp01" },
{ 0x0100F910020F8000, "BcatTestApp02" },
{ 0x0100B7D0020FC000, "BcatTestApp03" },
{ 0x0100132002100000, "BcatTestApp04" },
{ 0x0100935002116000, "BcatTestApp05" },
{ 0x0100DA4002130000, "BcatTestApp06" },
{ 0x0100B0F002104000, "BcatTestApp07" },
{ 0x010051E002132000, "BcatTestApp08" },
{ 0x01004CB0015C8000, "BcatTestApp09" },
{ 0x01009720015CA000, "BcatTestApp10" },
{ 0x01002F20015C6000, "BcatTestApp11" },
{ 0x0100204001F90000, "BcatTestApp12" },
{ 0x0100060001F92000, "BcatTestApp13" },
{ 0x0100C26001F94000, "BcatTestApp14" },
{ 0x0100462001F96000, "BcatTestApp15" },
{ 0x01005C6001F98000, "BcatTestApp16" },
{ 0x010070000E3C0000, "EncounterUsr" },
{ 0x010086000E49C000, "EncounterUsrDummy" },
{ 0x0100810002D5A000, "ShopMonitaringTool" },
{ 0x010023D002B98000, "DeltaStress" },
/* Pre-release system applets. */
{ 0x1000000000000001, "SystemInitializer" },
{ 0x1000000000000004, "CalWriter" },
{ 0x1000000000000005, "DevMenuCommand" },
{ 0x1000000000000006, "SettingsManager" },
{ 0x1000000000000007, "DevMenu" },
{ 0x100000000000000B, "SnapShotDumper" },
{ 0x100000000000000C, "SystemUpdater" },
{ 0x100000000000000E, "ControllerFirmwareUpdater" },
/* Pre-release system modules. */
{ 0x1000000000000201, "usb" },
{ 0x1000000000000202, "tma" },
{ 0x1000000000000203, "boot2" },
{ 0x1000000000000204, "settings" },
{ 0x1000000000000205, "bus" },
{ 0x1000000000000206, "bluetooth" },
{ 0x1000000000000208, "DebugMonitor0" },
{ 0x1000000000000209, "dmnt" },
{ 0x100000000000020B, "nifm" },
{ 0x100000000000020C, "ptm" },
{ 0x100000000000020D, "shell" },
{ 0x100000000000020E, "bsdsockets" },
{ 0x100000000000020F, "hid" },
{ 0x1000000000000210, "audio" },
{ 0x1000000000000212, "LogManager" },
{ 0x1000000000000213, "wlan" },
{ 0x1000000000000214, "cs" },
{ 0x1000000000000215, "ldn" },
{ 0x1000000000000216, "nvservices" },
{ 0x1000000000000217, "pcv" },
{ 0x1000000000000218, "ppc" },
{ 0x100000000000021A, "lbl0" },
{ 0x100000000000021B, "nvnflinger" },
{ 0x100000000000021C, "pcie" },
{ 0x100000000000021D, "account" },
{ 0x100000000000021E, "ns" },
{ 0x100000000000021F, "nfc" },
{ 0x1000000000000220, "psc" },
{ 0x1000000000000221, "capsrv" },
{ 0x1000000000000222, "am" }
};
static const u32 g_systemTitlesCount = MAX_ELEMENTS(g_systemTitles);
/* Function prototypes. */
NX_INLINE void titleFreeApplicationMetadata(void);
static bool titleReallocateApplicationMetadata(u32 extra_app_count, bool is_system, bool free_entries);
NX_INLINE bool titleInitializePersistentTitleStorages(void);
NX_INLINE void titleCloseTitleStorages(void);
static bool titleInitializeTitleStorage(u8 storage_id);
static void titleCloseTitleStorage(u8 storage_id);
static bool titleReallocateTitleInfoFromStorage(TitleStorage *title_storage, u32 extra_title_count, bool free_entries);
NX_INLINE void titleFreeOrphanTitleInfoEntries(void);
static void titleAddOrphanTitleInfoEntry(TitleInfo *orphan_title);
static bool titleGenerateMetadataEntriesFromSystemTitles(void);
static bool titleGenerateMetadataEntriesFromNsRecords(void);
static TitleApplicationMetadata *titleGenerateDummySystemMetadataEntry(u64 title_id);
static bool titleRetrieveUserApplicationMetadataByTitleId(u64 title_id, TitleApplicationMetadata *out);
NX_INLINE TitleApplicationMetadata *titleFindApplicationMetadataByTitleId(u64 title_id, bool is_system, u32 extra_app_count);
static bool titleGenerateTitleInfoEntriesForTitleStorage(TitleStorage *title_storage);
static bool titleGetMetaKeysFromContentDatabase(NcmContentMetaDatabase *ncm_db, NcmContentMetaKey **out_meta_keys, u32 *out_meta_key_count);
static bool titleGetContentInfosForMetaKey(NcmContentMetaDatabase *ncm_db, const NcmContentMetaKey *meta_key, NcmContentInfo **out_content_infos, u32 *out_content_count);
static void titleUpdateTitleInfoLinkedLists(void);
static bool titleCreateGameCardInfoThread(void);
static void titleDestroyGameCardInfoThread(void);
static void titleGameCardInfoThreadFunc(void *arg);
static bool titleRefreshGameCardTitleInfo(void);
static bool titleIsUserApplicationContentAvailable(u64 app_id);
static TitleInfo *_titleGetInfoFromStorageByTitleId(u8 storage_id, u64 title_id);
static TitleInfo *titleDuplicateTitleInfo(TitleInfo *title_info, TitleInfo *parent, TitleInfo *previous, TitleInfo *next);
static int titleSystemTitleMetadataEntrySortFunction(const void *a, const void *b);
static int titleUserApplicationMetadataEntrySortFunction(const void *a, const void *b);
static int titleOrphanTitleInfoSortFunction(const void *a, const void *b);
static char *titleGetPatchVersionString(TitleInfo *title_info);
bool titleInitialize(void)
{
bool ret = false;
SCOPED_LOCK(&g_titleMutex)
{
ret = g_titleInterfaceInit;
if (ret) break;
/* Allocate memory for the ns application control data. */
/* This will be used each time we need to retrieve the metadata from an application. */
g_nsAppControlData = calloc(1, sizeof(NsApplicationControlData));
if (!g_nsAppControlData)
{
LOG_MSG("Failed to allocate memory for the ns application control data!");
break;
}
/* Generate application metadata entries from hardcoded system titles, since we can't retrieve their names via ns. */
if (!titleGenerateMetadataEntriesFromSystemTitles())
{
LOG_MSG("Failed to generate application metadata from hardcoded system titles!");
break;
}
/* Generate application metadata entries from ns records. */
/* Theoretically speaking, we should only need to do this once. */
/* However, if any new gamecard is inserted while the application is running, we *will* have to retrieve the metadata from its application(s). */
if (!titleGenerateMetadataEntriesFromNsRecords())
{
LOG_MSG("Failed to generate application metadata from ns records!");
break;
}
/* Initialize persistent title storages (BuiltInSystem, BuiltInUser, SdCard). */
/* The background gamecard title thread will take care of initializing the gamecard title storage. */
if (!titleInitializePersistentTitleStorages())
{
LOG_MSG("Failed to initialize persistent title storages!");
break;
}
/* Create user-mode exit event. */
ueventCreate(&g_titleGameCardInfoThreadExitEvent, true);
/* Retrieve gamecard status change user event. */
g_titleGameCardStatusChangeUserEvent = gamecardGetStatusChangeUserEvent();
if (!g_titleGameCardStatusChangeUserEvent)
{
LOG_MSG("Failed to retrieve gamecard status change user event!");
break;
}
/* Create gamecard title info thread. */
if (!(g_titleGameCardInfoThreadCreated = titleCreateGameCardInfoThread())) break;
/* Update flags. */
ret = g_titleInterfaceInit = true;
}
return ret;
}
void titleExit(void)
{
SCOPED_LOCK(&g_titleMutex)
{
/* Destroy gamecard detection thread. */
if (g_titleGameCardInfoThreadCreated)
{
titleDestroyGameCardInfoThread();
g_titleGameCardInfoThreadCreated = false;
}
/* Close title storages. */
titleCloseTitleStorages();
/* Free orphan title info entries. */
titleFreeOrphanTitleInfoEntries();
/* Free application metadata. */
titleFreeApplicationMetadata();
/* Free ns application control data. */
if (g_nsAppControlData)
{
free(g_nsAppControlData);
g_nsAppControlData = NULL;
}
g_titleInterfaceInit = false;
}
}
NcmContentMetaDatabase *titleGetNcmDatabaseByStorageId(u8 storage_id)
{
u8 idx = TITLE_STORAGE_INDEX(storage_id);
return (idx < TITLE_STORAGE_COUNT ? &(g_titleStorage[idx].ncm_db) : NULL);
}
NcmContentStorage *titleGetNcmStorageByStorageId(u8 storage_id)
{
u8 idx = TITLE_STORAGE_INDEX(storage_id);
return (idx < TITLE_STORAGE_COUNT ? &(g_titleStorage[idx].ncm_storage) : NULL);
}
TitleApplicationMetadata **titleGetApplicationMetadataEntries(bool is_system, u32 *out_count)
{
u32 app_count = 0;
TitleApplicationMetadata **app_metadata = NULL, **tmp_app_metadata = NULL;
SCOPED_LOCK(&g_titleMutex)
{
if (!g_titleInterfaceInit || (is_system && (!g_systemMetadata || !g_systemMetadataCount)) || (!is_system && (!g_userMetadata || !g_userMetadataCount)) || !out_count)
{
LOG_MSG("Invalid parameters!");
break;
}
TitleApplicationMetadata **cached_app_metadata = (is_system ? g_systemMetadata : g_userMetadata);
u32 cached_app_metadata_count = (is_system ? g_systemMetadataCount : g_userMetadataCount);
bool error = false;
for(u32 i = 0; i < cached_app_metadata_count; i++)
{
TitleApplicationMetadata *cur_app_metadata = cached_app_metadata[i];
if (!cur_app_metadata) continue;
/* Skip current metadata entry if content data for this title isn't available. */
if ((is_system && !_titleGetInfoFromStorageByTitleId(NcmStorageId_BuiltInSystem, cur_app_metadata->title_id)) || \
(!is_system && !titleIsUserApplicationContentAvailable(cur_app_metadata->title_id))) continue;
/* Reallocate application metadata pointer array. */
tmp_app_metadata = realloc(app_metadata, (app_count + 1) * sizeof(TitleApplicationMetadata*));
if (!tmp_app_metadata)
{
LOG_MSG("Failed to reallocate application metadata pointer array!");
if (app_metadata) free(app_metadata);
app_metadata = NULL;
error = true;
break;
}
app_metadata = tmp_app_metadata;
tmp_app_metadata = NULL;
/* Set current pointer and increase counter. */
app_metadata[app_count++] = cur_app_metadata;
}
if (error) break;
/* Update output counter. */
*out_count = app_count;
if (!app_metadata || !app_count) LOG_MSG("No content data found for %s!", is_system ? "system titles" : "user applications");
}
return app_metadata;
}
TitleInfo *titleGetInfoFromStorageByTitleId(u8 storage_id, u64 title_id)
{
TitleInfo *ret = NULL;
SCOPED_LOCK(&g_titleMutex)
{
TitleInfo *title_info = (g_titleInterfaceInit ? _titleGetInfoFromStorageByTitleId(storage_id, title_id) : NULL);
if (title_info)
{
ret = titleDuplicateTitleInfo(title_info, NULL, NULL, NULL);
if (!ret) LOG_MSG("Failed to duplicate title info for %016lX!", title_id);
}
}
return ret;
}
void titleFreeTitleInfo(TitleInfo **info)
{
TitleInfo *ptr = NULL, *tmp1 = NULL, *tmp2 = NULL;
if (!info || !(ptr = *info)) return;
/* Free content infos. */
if (ptr->content_infos) free(ptr->content_infos);
/* Free parent linked list. */
titleFreeTitleInfo(&(ptr->parent));
/* Free previous sibling(s). */
tmp1 = ptr->previous;
while(tmp1)
{
tmp2 = tmp1->previous;
tmp1->parent = tmp1->previous = tmp1->next = NULL;
titleFreeTitleInfo(&tmp1);
tmp1 = tmp2;
}
/* Free next sibling(s). */
tmp1 = ptr->next;
while(tmp1)
{
tmp2 = tmp1->next;
tmp1->parent = tmp1->previous = tmp1->next = NULL;
titleFreeTitleInfo(&tmp1);
tmp1 = tmp2;
}
free(ptr);
*info = NULL;
}
bool titleGetUserApplicationData(u64 app_id, TitleUserApplicationData *out)
{
bool ret = false;
SCOPED_LOCK(&g_titleMutex)
{
if (!g_titleInterfaceInit || !app_id || !out)
{
LOG_MSG("Invalid parameters!");
break;
}
TitleInfo *app_info = NULL, *patch_info = NULL, *aoc_info = NULL;
/* Clear output. */
titleFreeUserApplicationData(out);
/* Get info for the first user application title. */
app_info = _titleGetInfoFromStorageByTitleId(NcmStorageId_Any, app_id);
if (app_info)
{
out->app_info = titleDuplicateTitleInfo(app_info, NULL, NULL, NULL);
if (!out->app_info)
{
LOG_MSG("Failed to duplicate user application info for %016lX!", app_id);
break;
}
}
/* Get info for the first patch title. */
patch_info = _titleGetInfoFromStorageByTitleId(NcmStorageId_Any, titleGetPatchIdByApplicationId(app_id));
if (patch_info)
{
out->patch_info = titleDuplicateTitleInfo(patch_info, out->app_info, NULL, NULL);
if (!out->patch_info)
{
LOG_MSG("Failed to duplicate patch info for %016lX!", app_id);
break;
}
}
/* Get info for the first add-on content title. */
for(u8 i = NcmStorageId_GameCard; i <= NcmStorageId_SdCard; i++)
{
if (i == NcmStorageId_BuiltInSystem) continue;
TitleStorage *title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(i)]);
if (!title_storage->titles || !title_storage->title_count) continue;
for(u32 j = 0; j < title_storage->title_count; j++)
{
TitleInfo *title_info = title_storage->titles[j];
if (title_info && title_info->meta_key.type == NcmContentMetaType_AddOnContent && titleCheckIfAddOnContentIdBelongsToApplicationId(app_id, title_info->meta_key.id))
{
aoc_info = title_info;
break;
}
}
if (aoc_info) break;
}
if (aoc_info)
{
out->aoc_info = titleDuplicateTitleInfo(aoc_info, out->app_info, NULL, NULL);
if (!out->aoc_info)
{
LOG_MSG("Failed to duplicate add-on content info for %016lX!", app_id);
break;
}
}
/* Check retrieved title info. */
ret = (app_info || patch_info || aoc_info);
if (!ret) LOG_MSG("Failed to retrieve user application data for ID \"%016lX\"!", app_id);
}
/* Clear output. */
if (!ret) titleFreeUserApplicationData(out);
return ret;
}
void titleFreeUserApplicationData(TitleUserApplicationData *user_app_data)
{
if (!user_app_data) return;
TitleInfo *tmp = NULL;
/* Free user application info. */
titleFreeTitleInfo(&(user_app_data->app_info));
/* Make sure to clear all references to the parent linked list beforehand. */
/* Unlike titleDuplicateTitleInfo(), we don't need to traverse backwards because elements from TitleUserApplicationData always point to the first title info. */
tmp = user_app_data->patch_info;
while(tmp)
{
tmp->parent = NULL;
tmp = tmp->next;
}
tmp = user_app_data->aoc_info;
while(tmp)
{
tmp->parent = NULL;
tmp = tmp->next;
}
/* Free patch info. */
titleFreeTitleInfo(&(user_app_data->patch_info));
/* Free add-on content info. */
titleFreeTitleInfo(&(user_app_data->aoc_info));
}
bool titleAreOrphanTitlesAvailable(void)
{
bool ret = false;
SCOPED_LOCK(&g_titleMutex) ret = (g_titleInterfaceInit && g_orphanTitleInfo && *g_orphanTitleInfo && g_orphanTitleInfoCount > 0);
return ret;
}
TitleInfo **titleGetOrphanTitles(u32 *out_count)
{
TitleInfo **orphan_info = NULL;
SCOPED_LOCK(&g_titleMutex)
{
if (!g_titleInterfaceInit || !g_orphanTitleInfo || !*g_orphanTitleInfo || !g_orphanTitleInfoCount || !out_count)
{
LOG_MSG("Invalid parameters!");
break;
}
/* Allocate orphan title info pointer array. */
orphan_info = calloc(g_orphanTitleInfoCount + 1, sizeof(TitleInfo*));
if (!orphan_info)
{
LOG_MSG("Failed to allocate memory for orphan title info pointer array!");
break;
}
/* Duplicate orphan title info entries. */
for(u32 i = 0; i < g_orphanTitleInfoCount; i++)
{
orphan_info[i] = titleDuplicateTitleInfo(g_orphanTitleInfo[i], NULL, NULL, NULL);
if (!orphan_info[i])
{
LOG_MSG("Failed to duplicate info for orphan title %016lX!", g_orphanTitleInfo[i]->meta_key.id);
titleFreeOrphanTitles(&orphan_info);
break;
}
}
/* Update output counter. */
if (orphan_info) *out_count = g_orphanTitleInfoCount;
}
return orphan_info;
}
void titleFreeOrphanTitles(TitleInfo ***orphan_info)
{
TitleInfo **ptr = NULL, *tmp = NULL;
if (!orphan_info || !(ptr = *orphan_info)) return;
tmp = *ptr;
while(tmp)
{
titleFreeTitleInfo(&tmp);
tmp++;
}
free(ptr);
*orphan_info = NULL;
}
bool titleIsGameCardInfoUpdated(void)
{
bool ret = false;
SCOPED_TRY_LOCK(&g_titleMutex)
{
/* Check if the gamecard thread detected a gamecard status change. */
ret = (g_titleInterfaceInit && g_titleGameCardInfoUpdated);
if (ret) g_titleGameCardInfoUpdated = false;
}
return ret;
}
char *titleGenerateFileName(TitleInfo *title_info, u8 name_convention, u8 illegal_char_replace_type)
{
if (!title_info || title_info->meta_key.type < NcmContentMetaType_Application || title_info->meta_key.type > NcmContentMetaType_Delta || name_convention > TitleFileNameConvention_IdAndVersionOnly || \
(name_convention == TitleFileNameConvention_Full && illegal_char_replace_type > TitleFileNameIllegalCharReplaceType_KeepAsciiCharsOnly))
{
LOG_MSG("Invalid parameters!");
return NULL;
}
u8 type = (title_info->meta_key.type - 0x80);
char title_name[0x400] = {0}, *version_str = NULL, *filename = NULL;
/* Generate filename for this title. */
if (name_convention == TitleFileNameConvention_Full)
{
if (title_info->app_metadata && *(title_info->app_metadata->lang_entry.name))
{
/* Retrieve display version string if we're dealing with a Patch. */
if (title_info->meta_key.type == NcmContentMetaType_Patch) version_str = titleGetPatchVersionString(title_info);
sprintf(title_name, "%s ", title_info->app_metadata->lang_entry.name);
if (version_str)
{
sprintf(title_name + strlen(title_name), "%s ", version_str);
free(version_str);
}
if (illegal_char_replace_type) utilsReplaceIllegalCharacters(title_name, illegal_char_replace_type == TitleFileNameIllegalCharReplaceType_KeepAsciiCharsOnly);
}
sprintf(title_name + strlen(title_name), "[%016lX][v%u][%s]", title_info->meta_key.id, title_info->meta_key.version, g_filenameTypeStrings[type]);
} else
if (name_convention == TitleFileNameConvention_IdAndVersionOnly)
{
sprintf(title_name, "%016lX_v%u_%s", title_info->meta_key.id, title_info->meta_key.version, g_filenameTypeStrings[type]);
}
/* Duplicate generated filename. */
filename = strdup(title_name);
if (!filename) LOG_MSG("Failed to duplicate generated filename!");
return filename;
}
char *titleGenerateGameCardFileName(u8 name_convention, u8 illegal_char_replace_type)
{
char *filename = NULL;
SCOPED_LOCK(&g_titleMutex)
{
TitleStorage *title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(NcmStorageId_GameCard)]);
TitleInfo **titles = title_storage->titles;
u32 title_count = title_storage->title_count;
if (!g_titleInterfaceInit || !g_titleGameCardAvailable || !titles || !title_count || name_convention > TitleFileNameConvention_IdAndVersionOnly || \
(name_convention == TitleFileNameConvention_Full && illegal_char_replace_type > TitleFileNameIllegalCharReplaceType_KeepAsciiCharsOnly))
{
LOG_MSG("Invalid parameters!");
break;
}
GameCardHeader gc_header = {0};
size_t cur_filename_len = 0;
char app_name[0x400] = {0};
bool error = false;
for(u32 i = 0; i < title_count; i++)
{
TitleInfo *app_info = titles[i], *patch_info = NULL;
if (!app_info || app_info->meta_key.type != NcmContentMetaType_Application) continue;
u32 app_version = app_info->meta_key.version;
/* Check if the inserted gamecard holds any bundled patches for the current user application. */
/* If so, we'll use the highest patch version available as part of the filename. */
for(u32 j = 0; j < title_count; j++)
{
if (j == i) continue;
TitleInfo *cur_title_info = titles[j];
if (!cur_title_info || cur_title_info->meta_key.type != NcmContentMetaType_Patch || !titleCheckIfPatchIdBelongsToApplicationId(app_info->meta_key.id, cur_title_info->meta_key.id) || \
cur_title_info->meta_key.version <= app_version) continue;
patch_info = cur_title_info;
app_version = cur_title_info->meta_key.version;
}
/* Generate current user application name. */
*app_name = '\0';
if (name_convention == TitleFileNameConvention_Full)
{
if (cur_filename_len) strcat(app_name, " + ");
if (app_info->app_metadata && *(app_info->app_metadata->lang_entry.name))
{
/* Retrieve display version string if the inserted gamecard holds a patch for the current user application. */
char *version_str = NULL;
if (patch_info) version_str = titleGetPatchVersionString(patch_info);
sprintf(app_name + strlen(app_name), "%s ", app_info->app_metadata->lang_entry.name);
if (version_str)
{
sprintf(app_name + strlen(app_name), "%s ", version_str);
free(version_str);
}
if (illegal_char_replace_type) utilsReplaceIllegalCharacters(app_name, illegal_char_replace_type == TitleFileNameIllegalCharReplaceType_KeepAsciiCharsOnly);
}
sprintf(app_name + strlen(app_name), "[%016lX][v%u]", app_info->meta_key.id, app_version);
} else
if (name_convention == TitleFileNameConvention_IdAndVersionOnly)
{
if (cur_filename_len) strcat(app_name, "+");
sprintf(app_name + strlen(app_name), "%016lX_v%u", app_info->meta_key.id, app_version);
}
/* Reallocate output buffer. */
size_t app_name_len = strlen(app_name);
char *tmp_filename = realloc(filename, (cur_filename_len + app_name_len + 1) * sizeof(char));
if (!tmp_filename)
{
LOG_MSG("Failed to reallocate filename buffer!");
if (filename) free(filename);
filename = NULL;
error = true;
break;
}
filename = tmp_filename;
tmp_filename = NULL;
/* Concatenate current user application name. */
filename[cur_filename_len] = '\0';
strcat(filename, app_name);
cur_filename_len += app_name_len;
}
if (!filename && !error)
{
LOG_MSG("Error: the inserted gamecard doesn't hold any user applications!");
/* Fallback string if no applications can be found. */
/* This function is guaranteed to fail with Kiosk / Quest gamecards, so that's why this is needed. */
sprintf(app_name, "gamecard");
if (gamecardGetHeader(&gc_header))
{
strcat(app_name, "_");
cur_filename_len = strlen(app_name);
utilsGenerateHexStringFromData(app_name + cur_filename_len, sizeof(app_name) - cur_filename_len, &(gc_header.package_id), sizeof(gc_header.package_id), false);
}
filename = strdup(app_name);
}
}
return filename;
}
const char *titleGetNcmContentTypeName(u8 content_type)
{
return (content_type <= NcmContentType_DeltaFragment ? g_titleNcmContentTypeNames[content_type] : NULL);
}
const char *titleGetNcmContentMetaTypeName(u8 content_meta_type)
{
if ((content_meta_type > NcmContentMetaType_BootImagePackageSafe && content_meta_type < NcmContentMetaType_Application) || content_meta_type > NcmContentMetaType_Delta) return NULL;
return (content_meta_type <= NcmContentMetaType_BootImagePackageSafe ? g_titleNcmContentMetaTypeNames[content_meta_type] : g_titleNcmContentMetaTypeNames[content_meta_type - 0x7A]);
}
NX_INLINE void titleFreeApplicationMetadata(void)
{
if (g_systemMetadata)
{
for(u32 i = 0; i < g_systemMetadataCount; i++)
{
TitleApplicationMetadata *cur_app_metadata = g_systemMetadata[i];
if (cur_app_metadata)
{
if (cur_app_metadata->icon) free(cur_app_metadata->icon);
free(cur_app_metadata);
}
}
free(g_systemMetadata);
g_systemMetadata = NULL;
}
g_systemMetadataCount = 0;
if (g_userMetadata)
{
for(u32 i = 0; i < g_userMetadataCount; i++)
{
TitleApplicationMetadata *cur_app_metadata = g_userMetadata[i];
if (cur_app_metadata)
{
if (cur_app_metadata->icon) free(cur_app_metadata->icon);
free(cur_app_metadata);
}
}
free(g_userMetadata);
g_userMetadata = NULL;
}
g_userMetadataCount = 0;
}
static bool titleReallocateApplicationMetadata(u32 extra_app_count, bool is_system, bool free_entries)
{
TitleApplicationMetadata **cached_app_metadata = (is_system ? g_systemMetadata : g_userMetadata), **tmp_app_metadata = NULL;
u32 cached_app_metadata_count = (is_system ? g_systemMetadataCount : g_userMetadataCount);
u32 realloc_app_count = (!free_entries ? (cached_app_metadata_count + extra_app_count) : cached_app_metadata_count);
bool success = false;
if (free_entries)
{
if (!cached_app_metadata)
{
LOG_MSG("Invalid parameters!");
goto end;
}
/* Free previously allocated application metadata entries. */
for(u32 i = 0; i <= extra_app_count; i++)
{
TitleApplicationMetadata *cur_app_metadata = cached_app_metadata[cached_app_metadata_count + i];
if (cur_app_metadata)
{
if (cur_app_metadata->icon) free(cur_app_metadata->icon);
free(cur_app_metadata);
cur_app_metadata = NULL;
}
}
}
if (realloc_app_count)
{
/* Reallocate application metadata pointer array. */
tmp_app_metadata = realloc(cached_app_metadata, realloc_app_count * sizeof(TitleApplicationMetadata*));
if (tmp_app_metadata)
{
/* Update application metadata pointer. */
cached_app_metadata = tmp_app_metadata;
tmp_app_metadata = NULL;
/* Clear new application metadata pointer array area (if needed). */
if (!free_entries && extra_app_count) memset(cached_app_metadata + cached_app_metadata_count, 0, extra_app_count * sizeof(TitleApplicationMetadata*));
} else {
LOG_MSG("Failed to reallocate application metadata pointer array! (%u element[s]).", realloc_app_count);
goto end;
}
} else
if (cached_app_metadata)
{
/* Free application metadata pointer array. */
free(cached_app_metadata);
cached_app_metadata = NULL;
}
/* Update global pointer array. */
if (is_system)
{
g_systemMetadata = cached_app_metadata;
} else {
g_userMetadata = cached_app_metadata;
}
/* Update flag. */
success = true;
end:
return success;
}
NX_INLINE bool titleInitializePersistentTitleStorages(void)
{
for(u8 i = NcmStorageId_BuiltInSystem; i <= NcmStorageId_SdCard; i++)
{
if (!titleInitializeTitleStorage(i))
{
LOG_MSG("Failed to initialize title storage with ID %u!", i);
return false;
}
}
return true;
}
NX_INLINE void titleCloseTitleStorages(void)
{
for(u8 i = NcmStorageId_GameCard; i <= NcmStorageId_SdCard; i++) titleCloseTitleStorage(i);
}
static bool titleInitializeTitleStorage(u8 storage_id)
{
if (storage_id < NcmStorageId_GameCard || storage_id > NcmStorageId_SdCard)
{
LOG_MSG("Invalid parameters!");
return false;
}
/* Close title storage before proceeding. */
titleCloseTitleStorage(storage_id);
TitleStorage *title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(storage_id)]);
NcmContentMetaDatabase *ncm_db = &(title_storage->ncm_db);
NcmContentStorage *ncm_storage = &(title_storage->ncm_storage);
Result rc = 0;
bool success = false;
/* Set ncm storage ID. */
title_storage->storage_id = storage_id;
/* Open ncm database. */
rc = ncmOpenContentMetaDatabase(ncm_db, storage_id);
if (R_FAILED(rc))
{
/* If the SD card is mounted, but it isn't currently being used by HOS, 0x21005 will be returned, so we'll just filter this particular error and continue. */
/* This can occur when using the "Nintendo" directory from a different console, or when the "sdmc:/Nintendo/Contents/private" file is corrupted. */
LOG_MSG("ncmOpenContentMetaDatabase failed for storage ID %u! (0x%08X).", storage_id, rc);
if (storage_id == NcmStorageId_SdCard && rc == 0x21005) success = true;
goto end;
}
/* Open ncm storage. */
rc = ncmOpenContentStorage(ncm_storage, storage_id);
if (R_FAILED(rc))
{
/* If the SD card is mounted, but it isn't currently being used by HOS, 0x21005 will be returned, so we'll just filter this particular error and continue. */
/* This can occur when using the "Nintendo" directory from a different console, or when the "sdmc:/Nintendo/Contents/private" file is corrupted. */
LOG_MSG("ncmOpenContentStorage failed for storage ID %u! (0x%08X).", storage_id, rc);
if (storage_id == NcmStorageId_SdCard && rc == 0x21005) success = true;
goto end;
}
/* Generate title info entries for this storage. */
if (!titleGenerateTitleInfoEntriesForTitleStorage(title_storage))
{
LOG_MSG("Failed to generate title info entries for storage ID %u!", storage_id);
goto end;
}
LOG_MSG("Loaded %u title info %s from storage ID %u.", title_storage->title_count, (title_storage->title_count == 1 ? "entry" : "entries"), storage_id);
/* Update flag. */
success = true;
end:
return success;
}
static void titleCloseTitleStorage(u8 storage_id)
{
if (storage_id < NcmStorageId_GameCard || storage_id > NcmStorageId_SdCard) return;
TitleStorage *title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(storage_id)]);
NcmContentMetaDatabase *ncm_db = &(title_storage->ncm_db);
NcmContentStorage *ncm_storage = &(title_storage->ncm_storage);
/* Free title infos from this title storage. */
if (title_storage->titles)
{
for(u32 i = 0; i < title_storage->title_count; i++)
{
TitleInfo *cur_title_info = title_storage->titles[i];
if (cur_title_info)
{
if (cur_title_info->content_infos) free(cur_title_info->content_infos);
free(cur_title_info);
}
}
free(title_storage->titles);
title_storage->titles = NULL;
}
/* Reset title count. */
title_storage->title_count = 0;
/* Check if the ncm storage handle for this title storage has already been retrieved. If so, close it. */
if (serviceIsActive(&(ncm_storage->s))) ncmContentStorageClose(ncm_storage);
/* Check if the ncm database handle for this title storage has already been retrieved. If so, close it. */
if (serviceIsActive(&(ncm_db->s))) ncmContentMetaDatabaseClose(ncm_db);
/* Reset ncm storage ID. */
title_storage->storage_id = NcmStorageId_None;
}
static bool titleReallocateTitleInfoFromStorage(TitleStorage *title_storage, u32 extra_title_count, bool free_entries)
{
if (!title_storage)
{
LOG_MSG("Invalid parameters!");
return false;
}
TitleInfo **title_info = title_storage->titles, **tmp_title_info = NULL;
u32 title_count = title_storage->title_count;
u32 realloc_title_count = (!free_entries ? (title_count + extra_title_count) : title_count);
bool success = false;
if (free_entries)
{
if (!title_info)
{
LOG_MSG("Invalid parameters!");
goto end;
}
/* Free previously allocated title info entries. */
for(u32 i = 0; i <= extra_title_count; i++)
{
TitleInfo *cur_title_info = title_info[title_count + i];
if (cur_title_info)
{
if (cur_title_info->content_infos) free(cur_title_info->content_infos);
free(cur_title_info);
cur_title_info = NULL;
}
}
}
if (realloc_title_count)
{
/* Reallocate title info pointer array. */
tmp_title_info = realloc(title_info, realloc_title_count * sizeof(TitleInfo*));
if (tmp_title_info)
{
/* Update title info pointer. */
title_info = tmp_title_info;
tmp_title_info = NULL;
/* Clear new title info pointer array area (if needed). */
if (!free_entries && extra_title_count) memset(title_info + title_count, 0, extra_title_count * sizeof(TitleInfo*));
} else {
LOG_MSG("Failed to reallocate title info pointer array! (%u element[s]).", realloc_title_count);
goto end;
}
} else
if (title_info)
{
/* Free title info pointer array. */
free(title_info);
title_info = NULL;
}
/* Update pointer array in global title storage. */
title_storage->titles = title_info;
/* Update flag. */
success = true;
end:
return success;
}
NX_INLINE void titleFreeOrphanTitleInfoEntries(void)
{
if (g_orphanTitleInfo)
{
free(g_orphanTitleInfo);
g_orphanTitleInfo = NULL;
}
g_orphanTitleInfoCount = 0;
}
static void titleAddOrphanTitleInfoEntry(TitleInfo *orphan_title)
{
if (!orphan_title) return;
/* Reallocate orphan title info pointer array. */
TitleInfo **tmp_orphan_info = realloc(g_orphanTitleInfo, (g_orphanTitleInfoCount + 1) * sizeof(TitleInfo*));
if (!tmp_orphan_info)
{
LOG_MSG("Failed to reallocate orphan title info pointer array!");
return;
}
g_orphanTitleInfo = tmp_orphan_info;
tmp_orphan_info = NULL;
/* Set orphan title info entry pointer. */
g_orphanTitleInfo[g_orphanTitleInfoCount++] = orphan_title;
/* Sort orphan title info entries by title ID. */
if (g_orphanTitleInfoCount > 1) qsort(g_orphanTitleInfo, g_orphanTitleInfoCount, sizeof(TitleInfo*), &titleOrphanTitleInfoSortFunction);
}
static bool titleGenerateMetadataEntriesFromSystemTitles(void)
{
u32 extra_app_count = 0;
bool success = false;
/* Reallocate application metadata pointer array. */
if (!titleReallocateApplicationMetadata(g_systemTitlesCount, true, false))
{
LOG_MSG("Failed to reallocate application metadata pointer array for system titles!");
return false;
}
/* Fill new application metadata entries. */
for(extra_app_count = 0; extra_app_count < g_systemTitlesCount; extra_app_count++)
{
/* Allocate memory for the current entry. */
TitleApplicationMetadata *cur_app_metadata = calloc(1, sizeof(TitleApplicationMetadata));
if (!cur_app_metadata)
{
LOG_MSG("Failed to allocate memory for application metadata entry #%u!", extra_app_count);
goto end;
}
/* Fill information. */
const TitleSystemEntry *system_title = &(g_systemTitles[extra_app_count]);
cur_app_metadata->title_id = system_title->title_id;
sprintf(cur_app_metadata->lang_entry.name, system_title->name);
/* Set application metadata entry pointer. */
g_systemMetadata[g_systemMetadataCount + extra_app_count] = cur_app_metadata;
}
/* Update application metadata count. */
g_systemMetadataCount += g_systemTitlesCount;
/* Sort metadata entries by title ID. */
if (g_systemMetadataCount > 1) qsort(g_systemMetadata, g_systemMetadataCount, sizeof(TitleApplicationMetadata*), &titleSystemTitleMetadataEntrySortFunction);
/* Update flag. */
success = true;
end:
/* Free previously allocated application metadata pointers. Ignore return value. */
if (!success) titleReallocateApplicationMetadata(extra_app_count, true, true);
return success;
}
static bool titleGenerateMetadataEntriesFromNsRecords(void)
{
Result rc = 0;
NsApplicationRecord *app_records = NULL;
u32 app_records_count = 0, extra_app_count = 0;
bool success = false, free_entries = false;
/* Allocate memory for the NS application records. */
app_records = calloc(NS_APPLICATION_RECORD_LIMIT, sizeof(NsApplicationRecord));
if (!app_records)
{
LOG_MSG("Failed to allocate memory for NS application records!");
return false;
}
/* Retrieve NS application records. */
rc = nsListApplicationRecord(app_records, NS_APPLICATION_RECORD_LIMIT, 0, (s32*)&app_records_count);
if (R_FAILED(rc))
{
LOG_MSG("nsListApplicationRecord failed! (0x%08X).", rc);
goto end;
}
/* Return right away if no records were retrieved. */
if (!app_records_count)
{
success = true;
goto end;
}
/* Reallocate application metadata pointer array. */
if (!titleReallocateApplicationMetadata(app_records_count, false, false))
{
LOG_MSG("Failed to reallocate application metadata pointer array for NS records!");
goto end;
}
free_entries = true;
/* Retrieve application metadata for each NS application record. */
for(u32 i = 0; i < app_records_count; i++)
{
TitleApplicationMetadata *cur_app_metadata = g_userMetadata[g_userMetadataCount + extra_app_count];
if (!cur_app_metadata)
{
/* Allocate memory for a new application metadata entry. */
cur_app_metadata = calloc(1, sizeof(TitleApplicationMetadata));
if (!cur_app_metadata)
{
LOG_MSG("Failed to allocate memory for application metadata entry #%u! (%u / %u).", extra_app_count, i + 1, app_records_count);
goto end;
}
/* Set application metadata entry pointer. */
g_userMetadata[g_userMetadataCount + extra_app_count] = cur_app_metadata;
}
/* Retrieve application metadata. */
if (!titleRetrieveUserApplicationMetadataByTitleId(app_records[i].application_id, cur_app_metadata)) continue;
/* Increase extra application metadata counter. */
extra_app_count++;
}
/* Check retrieved application metadata count. */
if (!extra_app_count)
{
LOG_MSG("Unable to retrieve application metadata from NS application records! (%u element[s]).", app_records_count);
goto end;
}
/* Update application metadata count. */
g_userMetadataCount += extra_app_count;
/* Free extra allocated pointers if we didn't use them. */
if (extra_app_count < app_records_count) titleReallocateApplicationMetadata(0, false, false);
/* Sort application metadata entries by name. */
if (g_userMetadataCount > 1) qsort(g_userMetadata, g_userMetadataCount, sizeof(TitleApplicationMetadata*), &titleUserApplicationMetadataEntrySortFunction);
/* Update flag. */
success = true;
end:
if (app_records) free(app_records);
/* Free previously allocated application metadata pointers. Ignore return value. */
if (!success && free_entries) titleReallocateApplicationMetadata(extra_app_count, false, true);
return success;
}
static TitleApplicationMetadata *titleGenerateDummySystemMetadataEntry(u64 title_id)
{
if (!title_id)
{
LOG_MSG("Invalid parameters!");
return NULL;
}
TitleApplicationMetadata *cur_app_metadata = NULL;
bool free_entry = false;
/* Reallocate application metadata pointer array. */
if (!titleReallocateApplicationMetadata(1, true, false))
{
LOG_MSG("Failed to reallocate application metadata pointer array for %016lX!", title_id);
goto end;
}
free_entry = true;
/* Allocate memory for the current entry. */
cur_app_metadata = calloc(1, sizeof(TitleApplicationMetadata));
if (!cur_app_metadata)
{
LOG_MSG("Failed to allocate memory for application metadata %016lX!", title_id);
goto end;
}
/* Fill information. */
cur_app_metadata->title_id = title_id;
sprintf(cur_app_metadata->lang_entry.name, "Unknown");
/* Set application metadata entry pointer. */
g_systemMetadata[g_systemMetadataCount++] = cur_app_metadata;
/* Sort metadata entries by title ID. */
if (g_systemMetadataCount > 1) qsort(g_systemMetadata, g_systemMetadataCount, sizeof(TitleApplicationMetadata*), &titleSystemTitleMetadataEntrySortFunction);
end:
/* Free previously allocated application metadata pointer. Ignore return value. */
if (!cur_app_metadata && free_entry) titleReallocateApplicationMetadata(0, true, false);
return cur_app_metadata;
}
static bool titleRetrieveUserApplicationMetadataByTitleId(u64 title_id, TitleApplicationMetadata *out)
{
if (!g_nsAppControlData || !title_id || !out)
{
LOG_MSG("Invalid parameters!");
return false;
}
Result rc = 0;
u64 write_size = 0;
NacpLanguageEntry *lang_entry = NULL;
u32 icon_size = 0;
u8 *icon = NULL;
/* Retrieve ns application control data. */
rc = nsGetApplicationControlData(NsApplicationControlSource_Storage, title_id, g_nsAppControlData, sizeof(NsApplicationControlData), &write_size);
if (R_FAILED(rc))
{
LOG_MSG("nsGetApplicationControlData failed for title ID \"%016lX\"! (0x%08X).", title_id, rc);
return false;
}
if (write_size < sizeof(NacpStruct))
{
LOG_MSG("Retrieved application control data buffer is too small! (0x%lX).", write_size);
return false;
}
/* Get language entry. */
rc = nacpGetLanguageEntry(&(g_nsAppControlData->nacp), &lang_entry);
if (R_FAILED(rc))
{
LOG_MSG("nacpGetLanguageEntry failed! (0x%08X).", rc);
return false;
}
/* Get icon. */
icon_size = (u32)(write_size - sizeof(NacpStruct));
if (icon_size)
{
icon = malloc(icon_size);
if (!icon)
{
LOG_MSG("Error allocating memory for the icon buffer! (0x%X).", icon_size);
return false;
}
memcpy(icon, g_nsAppControlData->icon, icon_size);
}
/* Copy data. */
out->title_id = title_id;
memcpy(&(out->lang_entry), lang_entry, sizeof(NacpLanguageEntry));
utilsTrimString(out->lang_entry.name);
utilsTrimString(out->lang_entry.author);
out->icon_size = icon_size;
out->icon = icon;
return true;
}
NX_INLINE TitleApplicationMetadata *titleFindApplicationMetadataByTitleId(u64 title_id, bool is_system, u32 extra_app_count)
{
if ((is_system && (!g_systemMetadata || !g_systemMetadataCount)) || (!is_system && (!g_userMetadata || !g_userMetadataCount)) || !title_id) return NULL;
TitleApplicationMetadata **cached_app_metadata = (is_system ? g_systemMetadata : g_userMetadata);
u32 cached_app_metadata_count = ((is_system ? g_systemMetadataCount : g_userMetadataCount) + extra_app_count);
for(u32 i = 0; i < cached_app_metadata_count; i++)
{
TitleApplicationMetadata *cur_app_metadata = cached_app_metadata[i];
if (cur_app_metadata && cur_app_metadata->title_id == title_id) return cur_app_metadata;
}
return NULL;
}
static bool titleGenerateTitleInfoEntriesForTitleStorage(TitleStorage *title_storage)
{
if (!title_storage || title_storage->storage_id < NcmStorageId_GameCard || title_storage->storage_id > NcmStorageId_SdCard || !serviceIsActive(&(title_storage->ncm_db.s)))
{
LOG_MSG("Invalid parameters!");
return false;
}
u8 storage_id = title_storage->storage_id;
NcmContentMetaDatabase *ncm_db = &(title_storage->ncm_db);
u32 total = 0, extra_title_count = 0;
NcmContentMetaKey *meta_keys = NULL;
bool success = false, free_entries = false;
/* Get content meta keys for this storage. */
if (!titleGetMetaKeysFromContentDatabase(ncm_db, &meta_keys, &total)) goto end;
/* Check if we're dealing with an empty storage. */
if (!total)
{
success = true;
goto end;
}
/* Reallocate pointer array in title storage. */
if (!titleReallocateTitleInfoFromStorage(title_storage, total, false)) goto end;
free_entries = true;
/* Fill new title info entries. */
for(u32 i = 0; i < total; i++)
{
u64 tmp_size = 0;
NcmContentMetaKey *cur_meta_key = &(meta_keys[i]);
TitleInfo *cur_title_info = title_storage->titles[title_storage->title_count + extra_title_count];
if (!cur_title_info)
{
/* Allocate memory for a new entry. */
cur_title_info = calloc(1, sizeof(TitleInfo));
if (!cur_title_info)
{
LOG_MSG("Failed to allocate memory for title info entry #%u! (%u / %u).", extra_title_count, i + 1, total);
goto end;
}
/* Set title info entry pointer. */
title_storage->titles[title_storage->title_count + extra_title_count] = cur_title_info;
}
/* Get content infos. */
if (!titleGetContentInfosForMetaKey(ncm_db, cur_meta_key, &(cur_title_info->content_infos), &(cur_title_info->content_count)))
{
LOG_MSG("Failed to get content infos for title ID %016lX!", cur_meta_key->id);
continue;
}
/* Calculate title size. */
for(u32 j = 0; j < cur_title_info->content_count; j++)
{
titleConvertNcmContentSizeToU64(cur_title_info->content_infos[j].size, &tmp_size);
cur_title_info->size += tmp_size;
}
/* Fill information. */
cur_title_info->storage_id = storage_id;
memcpy(&(cur_title_info->meta_key), cur_meta_key, sizeof(NcmContentMetaKey));
cur_title_info->version.value = cur_title_info->meta_key.version;
utilsGenerateFormattedSizeString(cur_title_info->size, cur_title_info->size_str, sizeof(cur_title_info->size_str));
/* Retrieve application metadata. */
u64 app_id = (cur_title_info->meta_key.type <= NcmContentMetaType_Application ? cur_title_info->meta_key.id : \
(cur_title_info->meta_key.type == NcmContentMetaType_Patch ? titleGetApplicationIdByPatchId(cur_title_info->meta_key.id) : \
(cur_title_info->meta_key.type == NcmContentMetaType_AddOnContent ? titleGetApplicationIdByAddOnContentId(cur_title_info->meta_key.id) : \
titleGetApplicationIdByDeltaId(cur_title_info->meta_key.id))));
cur_title_info->app_metadata = titleFindApplicationMetadataByTitleId(app_id, storage_id == NcmStorageId_BuiltInSystem, 0);
if (!cur_title_info->app_metadata && storage_id == NcmStorageId_BuiltInSystem)
{
/* Generate dummy system metadata entry if we have no hardcoded information for this system title. */
cur_title_info->app_metadata = titleGenerateDummySystemMetadataEntry(cur_title_info->meta_key.id);
}
/* Increase extra title info counter. */
extra_title_count++;
}
/* Check retrieved title info count. */
if (!extra_title_count)
{
LOG_MSG("Unable to generate title info entries! (%u element[s]).", total);
goto end;
}
/* Update title info count. */
title_storage->title_count += extra_title_count;
/* Free extra allocated pointers if we didn't use them. */
if (extra_title_count < total) titleReallocateTitleInfoFromStorage(title_storage, 0, false);
/* Update linked lists for user applications, patches and add-on contents. */
/* This will also keep track of orphan titles - titles with no available application metadata. */
titleUpdateTitleInfoLinkedLists();
/* Update flag. */
success = true;
end:
if (meta_keys) free(meta_keys);
/* Free previously allocated title info pointers. Ignore return value. */
if (!success && free_entries) titleReallocateTitleInfoFromStorage(title_storage, extra_title_count, true);
return success;
}
static bool titleGetMetaKeysFromContentDatabase(NcmContentMetaDatabase *ncm_db, NcmContentMetaKey **out_meta_keys, u32 *out_meta_key_count)
{
if (!ncm_db || !serviceIsActive(&(ncm_db->s)) || !out_meta_keys || !out_meta_key_count)
{
LOG_MSG("Invalid parameters!");
return false;
}
Result rc = 0;
u32 written = 0, total = 0;
NcmContentMetaKey *meta_keys = NULL, *meta_keys_tmp = NULL;
size_t meta_keys_size = sizeof(NcmContentMetaKey);
bool success = false;
/* Allocate memory for the ncm application content meta keys. */
meta_keys = calloc(1, meta_keys_size);
if (!meta_keys)
{
LOG_MSG("Unable to allocate memory for the ncm application meta keys!");
goto end;
}
/* Get a full list of all titles available in this storage. */
/* Meta type '0' means all title types will be retrieved. */
rc = ncmContentMetaDatabaseList(ncm_db, (s32*)&total, (s32*)&written, meta_keys, 1, 0, 0, 0, UINT64_MAX, NcmContentInstallType_Full);
if (R_FAILED(rc))
{
LOG_MSG("ncmContentMetaDatabaseList failed! (0x%08X) (first entry).", rc);
goto end;
}
/* Check if our application meta keys buffer was actually filled. */
/* If it wasn't, odds are there are no titles in this storage. */
if (!written || !total)
{
*out_meta_key_count = 0;
success = true;
goto end;
}
/* Check if we need to resize our application meta keys buffer. */
if (total > written)
{
/* Update application meta keys buffer size. */
meta_keys_size *= total;
/* Reallocate application meta keys buffer. */
meta_keys_tmp = realloc(meta_keys, meta_keys_size);
if (!meta_keys_tmp)
{
LOG_MSG("Unable to reallocate application meta keys buffer! (%u entries).", total);
goto end;
}
meta_keys = meta_keys_tmp;
meta_keys_tmp = NULL;
/* Issue call again. */
rc = ncmContentMetaDatabaseList(ncm_db, (s32*)&total, (s32*)&written, meta_keys, (s32)total, 0, 0, 0, UINT64_MAX, NcmContentInstallType_Full);
if (R_FAILED(rc))
{
LOG_MSG("ncmContentMetaDatabaseList failed! (0x%08X) (%u %s).", rc, total, total > 1 ? "entries" : "entry");
goto end;
}
/* Safety check. */
if (written != total)
{
LOG_MSG("Application meta key count mismatch! (%u != %u).", written, total);
goto end;
}
}
/* Update output. */
*out_meta_keys = meta_keys;
*out_meta_key_count = total;
success = true;
end:
if (!success && meta_keys) free(meta_keys);
return success;
}
static bool titleGetContentInfosForMetaKey(NcmContentMetaDatabase *ncm_db, const NcmContentMetaKey *meta_key, NcmContentInfo **out_content_infos, u32 *out_content_count)
{
if (!ncm_db || !serviceIsActive(&(ncm_db->s)) || !meta_key || !out_content_infos || !out_content_count)
{
LOG_MSG("Invalid parameters!");
return false;
}
Result rc = 0;
NcmContentMetaHeader content_meta_header = {0};
u64 content_meta_header_read_size = 0;
NcmContentInfo *content_infos = NULL;
u32 content_count = 0, written = 0;
bool success = false;
/* Retrieve content meta header. */
rc = ncmContentMetaDatabaseGet(ncm_db, meta_key, &content_meta_header_read_size, &content_meta_header, sizeof(NcmContentMetaHeader));
if (R_FAILED(rc))
{
LOG_MSG("ncmContentMetaDatabaseGet failed! (0x%08X).", rc);
goto end;
}
if (content_meta_header_read_size != sizeof(NcmContentMetaHeader))
{
LOG_MSG("Content meta header size mismatch! (0x%lX != 0x%lX).", content_meta_header_read_size, sizeof(NcmContentMetaHeader));
goto end;
}
/* Get content count. */
content_count = (u32)content_meta_header.content_count;
if (!content_count)
{
LOG_MSG("Content count is zero!");
goto end;
}
/* Allocate memory for the content infos. */
content_infos = calloc(content_count, sizeof(NcmContentInfo));
if (!content_infos)
{
LOG_MSG("Unable to allocate memory for the content infos buffer! (%u content[s]).", content_count);
goto end;
}
/* Retrieve content infos. */
rc = ncmContentMetaDatabaseListContentInfo(ncm_db, (s32*)&written, content_infos, (s32)content_count, meta_key, 0);
if (R_FAILED(rc))
{
LOG_MSG("ncmContentMetaDatabaseListContentInfo failed! (0x%08X).", rc);
goto end;
}
if (written != content_count)
{
LOG_MSG("Content count mismatch! (%u != %u).", written, content_count);
goto end;
}
/* Update output. */
*out_content_infos = content_infos;
*out_content_count = content_count;
success = true;
end:
if (!success && content_infos) free(content_infos);
return success;
}
static void titleUpdateTitleInfoLinkedLists(void)
{
/* Free orphan title info entries. */
titleFreeOrphanTitleInfoEntries();
/* Loop through all available title storages. */
for(u8 i = NcmStorageId_GameCard; i <= NcmStorageId_SdCard; i++)
{
/* Don't process system titles. */
if (i == NcmStorageId_BuiltInSystem) continue;
TitleStorage *title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(i)]);
TitleInfo **titles = title_storage->titles;
u32 title_count = title_storage->title_count;
/* Don't proceed if the current storage holds no titles. */
if (!titles || !title_count) continue;
/* Process titles from the current storage. */
for(u32 j = 0; j < title_count; j++)
{
/* Get pointer to the current title info and reset its linked list pointers. */
/* Don't proceed if we're dealing with a title that's not an user application, patch or add-on content. */
TitleInfo *child_info = titles[j];
if (!child_info || child_info->meta_key.type < NcmContentMetaType_Application || child_info->meta_key.type > NcmContentMetaType_AddOnContent) continue;
child_info->parent = child_info->previous = child_info->next = NULL;
if (child_info->meta_key.type == NcmContentMetaType_Patch || child_info->meta_key.type == NcmContentMetaType_AddOnContent)
{
/* We're dealing with a patch or an add-on content. */
/* Retrieve pointer to the first parent user application entry for patches and add-on contents. */
u64 app_id = (child_info->meta_key.type == NcmContentMetaType_Patch ? titleGetApplicationIdByPatchId(child_info->meta_key.id) : \
titleGetApplicationIdByAddOnContentId(child_info->meta_key.id));
child_info->parent = _titleGetInfoFromStorageByTitleId(NcmStorageId_Any, app_id);
if (child_info->parent && !child_info->app_metadata) child_info->app_metadata = child_info->parent->app_metadata;
/* Add orphan title info entry if we have no application metadata. */
if (!child_info->app_metadata)
{
titleAddOrphanTitleInfoEntry(child_info);
continue;
}
}
/* Locate previous user application, patch or add-on content entry. */
/* If it's found, we will update both its next pointer and the previous pointer from the current entry. */
for(u8 k = i; k >= NcmStorageId_GameCard; k--)
{
/* Don't process system titles. And don't proceed if we're currently dealing with the first entry from a storage. */
if (k == NcmStorageId_BuiltInSystem || (k == i && j == 0)) continue;
TitleStorage *prev_title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(k)]);
TitleInfo **prev_titles = prev_title_storage->titles;
u32 prev_title_count = prev_title_storage->title_count;
u32 start_idx = (k == i ? j : prev_title_count);
/* Don't proceed if the current storage holds no titles. */
if (!prev_titles || !prev_title_count) continue;
for(u32 l = start_idx; l > 0; l--)
{
TitleInfo *prev_info = prev_titles[l - 1];
if (!prev_info) continue;
if (prev_info->meta_key.type == child_info->meta_key.type && \
(((child_info->meta_key.type == NcmContentMetaType_Application || child_info->meta_key.type == NcmContentMetaType_Patch) && prev_info->meta_key.id == child_info->meta_key.id) || \
(child_info->meta_key.type == NcmContentMetaType_AddOnContent && titleCheckIfAddOnContentIdsAreSiblings(prev_info->meta_key.id, child_info->meta_key.id))))
{
prev_info->next = child_info;
child_info->previous = prev_info;
break;
}
}
if (child_info->previous) break;
}
}
}
}
static bool titleCreateGameCardInfoThread(void)
{
if (!utilsCreateThread(&g_titleGameCardInfoThread, titleGameCardInfoThreadFunc, NULL, 1))
{
LOG_MSG("Failed to create gamecard title info thread!");
return false;
}
return true;
}
static void titleDestroyGameCardInfoThread(void)
{
/* Signal the exit event to terminate the gamecard title info thread. */
ueventSignal(&g_titleGameCardInfoThreadExitEvent);
/* Wait for the gamecard title info thread to exit. */
utilsJoinThread(&g_titleGameCardInfoThread);
}
static void titleGameCardInfoThreadFunc(void *arg)
{
(void)arg;
Result rc = 0;
int idx = 0;
Waiter gamecard_status_event_waiter = waiterForUEvent(g_titleGameCardStatusChangeUserEvent);
Waiter exit_event_waiter = waiterForUEvent(&g_titleGameCardInfoThreadExitEvent);
while(true)
{
/* Wait until an event is triggered. */
rc = waitMulti(&idx, -1, gamecard_status_event_waiter, exit_event_waiter);
if (R_FAILED(rc)) continue;
/* Exit event triggered. */
if (idx == 1) break;
/* Update gamecard title info. */
SCOPED_LOCK(&g_titleMutex) g_titleGameCardInfoUpdated = titleRefreshGameCardTitleInfo();
}
/* Update gamecard flags. */
g_titleGameCardAvailable = g_titleGameCardInfoUpdated = false;
threadExit();
}
static bool titleRefreshGameCardTitleInfo(void)
{
TitleStorage *title_storage = NULL;
TitleInfo **titles = NULL;
u32 title_count = 0, gamecard_app_count = 0, extra_app_count = 0;
bool status = false, success = false, cleanup = true, free_entries = false;
/* Retrieve current gamecard status. */
status = (gamecardGetStatus() == GameCardStatus_InsertedAndInfoLoaded);
if (status == g_titleGameCardAvailable || !status)
{
success = cleanup = (status != g_titleGameCardAvailable);
goto end;
}
/* Initialize gamecard title storage. */
if (!titleInitializeTitleStorage(NcmStorageId_GameCard))
{
LOG_MSG("Failed to initialize gamecard title storage!");
goto end;
}
/* Get gamecard title storage info. */
title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(NcmStorageId_GameCard)]);
titles = title_storage->titles;
title_count = title_storage->title_count;
/* Verify title count. */
if (!title_count)
{
LOG_MSG("Gamecard title count is zero!");
goto end;
}
/* Get gamecard user application count. */
for(u32 i = 0; i < title_count; i++)
{
TitleInfo *cur_title_info = titles[i];
if (cur_title_info && cur_title_info->meta_key.type == NcmContentMetaType_Application) gamecard_app_count++;
}
/* Return immediately if, for some reason, there are no user applications. */
if (!gamecard_app_count)
{
success = true;
cleanup = false;
goto end;
}
/* Reallocate application metadata pointer array. */
if (!titleReallocateApplicationMetadata(gamecard_app_count, false, false))
{
LOG_MSG("Failed to reallocate application metadata pointer array for gamecard user applications!");
goto end;
}
free_entries = true;
/* Retrieve application metadata for gamecard user applications. */
for(u32 i = 0; i < title_count; i++)
{
TitleInfo *cur_title_info = titles[i];
if (!cur_title_info) continue;
u64 app_id = (cur_title_info->meta_key.type <= NcmContentMetaType_Application ? cur_title_info->meta_key.id : \
(cur_title_info->meta_key.type == NcmContentMetaType_Patch ? titleGetApplicationIdByPatchId(cur_title_info->meta_key.id) : \
(cur_title_info->meta_key.type == NcmContentMetaType_AddOnContent ? titleGetApplicationIdByAddOnContentId(cur_title_info->meta_key.id) : \
titleGetApplicationIdByDeltaId(cur_title_info->meta_key.id))));
/* Do not proceed if application metadata has already been retrieved, or if we can successfully retrieve it. */
if (cur_title_info->app_metadata != NULL || (cur_title_info->app_metadata = titleFindApplicationMetadataByTitleId(app_id, false, extra_app_count)) != NULL) continue;
/* Retrieve application metadata pointer. */
TitleApplicationMetadata *cur_app_metadata = g_userMetadata[g_userMetadataCount + extra_app_count];
if (!cur_app_metadata)
{
/* Allocate memory for a new application metadata entry. */
cur_app_metadata = calloc(1, sizeof(TitleApplicationMetadata));
if (!cur_app_metadata)
{
LOG_MSG("Failed to allocate memory for application metadata entry #%u!", extra_app_count);
goto end;
}
/* Set application metadata entry pointer. */
g_userMetadata[g_userMetadataCount + extra_app_count] = cur_app_metadata;
}
/* Retrieve application metadata. */
if (!titleRetrieveUserApplicationMetadataByTitleId(app_id, cur_app_metadata)) continue;
/* Update application metadata pointer in title info. */
cur_title_info->app_metadata = cur_app_metadata;
/* Increase extra application metadata counter. */
extra_app_count++;
}
if (extra_app_count)
{
/* Update application metadata count. */
g_userMetadataCount += extra_app_count;
/* Sort application metadata entries by name. */
if (g_userMetadataCount > 1) qsort(g_userMetadata, g_userMetadataCount, sizeof(TitleApplicationMetadata*), &titleUserApplicationMetadataEntrySortFunction);
/* Update linked lists for user applications, patches and add-on contents. */
/* This will take care of orphan titles we might now have application metadata for. */
titleUpdateTitleInfoLinkedLists();
} else
if (g_userMetadata[g_userMetadataCount])
{
/* Free leftover application metadata entry (if needed). */
free(g_userMetadata[g_userMetadataCount]);
g_userMetadata[g_userMetadataCount] = NULL;
}
/* Free extra allocated pointers if we didn't use them. */
if (extra_app_count < gamecard_app_count) titleReallocateApplicationMetadata(0, false, false);
/* Update flags. */
success = true;
cleanup = false;
end:
/* Update gamecard status. */
g_titleGameCardAvailable = status;
/* Free previously allocated application metadata pointers. Ignore return value. */
if (!success && free_entries) titleReallocateApplicationMetadata(extra_app_count, false, true);
if (cleanup)
{
/* Close gamecard title storage. */
titleCloseTitleStorage(NcmStorageId_GameCard);
/* Update linked lists for user applications, patches and add-on contents. */
titleUpdateTitleInfoLinkedLists();
}
return success;
}
static bool titleIsUserApplicationContentAvailable(u64 app_id)
{
if (!app_id) return false;
for(u8 i = NcmStorageId_GameCard; i <= NcmStorageId_SdCard; i++)
{
if (i == NcmStorageId_BuiltInSystem) continue;
TitleStorage *title_storage = &(g_titleStorage[TITLE_STORAGE_INDEX(i)]);
if (!title_storage->titles || !*(title_storage->titles) || !title_storage->title_count) continue;
for(u32 j = 0; j < title_storage->title_count; j++)
{
TitleInfo *title_info = title_storage->titles[j];
if (!title_info) continue;
if ((title_info->meta_key.type == NcmContentMetaType_Application && title_info->meta_key.id == app_id) || \
(title_info->meta_key.type == NcmContentMetaType_Patch && titleCheckIfPatchIdBelongsToApplicationId(app_id, title_info->meta_key.id)) || \
(title_info->meta_key.type == NcmContentMetaType_AddOnContent && titleCheckIfAddOnContentIdBelongsToApplicationId(app_id, title_info->meta_key.id))) return true;
}
}
return false;
}
static TitleInfo *_titleGetInfoFromStorageByTitleId(u8 storage_id, u64 title_id)
{
if (storage_id < NcmStorageId_GameCard || storage_id > NcmStorageId_Any || !title_id)
{
LOG_MSG("Invalid parameters!");
return NULL;
}
TitleInfo *out = NULL;
u8 start_idx = (storage_id == NcmStorageId_Any ? TITLE_STORAGE_INDEX(NcmStorageId_GameCard) : TITLE_STORAGE_INDEX(storage_id));
u8 max_val = (storage_id == NcmStorageId_Any ? TITLE_STORAGE_INDEX(NcmStorageId_SdCard) : start_idx);
for(u8 i = start_idx; i <= max_val; i++)
{
TitleStorage *title_storage = &(g_titleStorage[i]);
if (!title_storage->titles || !*(title_storage->titles) || !title_storage->title_count) continue;
for(u32 j = 0; j < title_storage->title_count; j++)
{
TitleInfo *title_info = title_storage->titles[j];
if (title_info && title_info->meta_key.id == title_id)
{
out = title_info;
break;
}
}
if (out) break;
}
//if (!info) LOG_MSG("Unable to find title info entry with ID \"%016lX\"! (storage ID %u).", title_id, storage_id);
return out;
}
static TitleInfo *titleDuplicateTitleInfo(TitleInfo *title_info, TitleInfo *parent, TitleInfo *previous, TitleInfo *next)
{
if (!title_info || title_info->storage_id < NcmStorageId_GameCard || title_info->storage_id > NcmStorageId_SdCard || !title_info->meta_key.id || \
(title_info->meta_key.type > NcmContentMetaType_BootImagePackageSafe && title_info->meta_key.type < NcmContentMetaType_Application) || title_info->meta_key.type > NcmContentMetaType_Delta || \
!title_info->content_count || !title_info->content_infos)
{
LOG_MSG("Invalid parameters!");
return NULL;
}
TitleInfo *title_info_dup = NULL, *tmp1 = NULL, *tmp2 = NULL;
NcmContentInfo *content_infos_dup = NULL;
bool dup_parent = false, dup_previous = false, dup_next = false, success = false;
/* Allocate memory for the new TitleInfo element. */
title_info_dup = calloc(1, sizeof(TitleInfo));
if (!title_info_dup)
{
LOG_MSG("Failed to allocate memory for TitleInfo duplicate!");
return NULL;
}
/* Copy TitleInfo data. */
memcpy(title_info_dup, title_info, sizeof(TitleInfo));
title_info_dup->parent = title_info_dup->previous = title_info_dup->next = NULL;
/* Allocate memory for NcmContentInfo elements. */
content_infos_dup = calloc(title_info->content_count, sizeof(NcmContentInfo));
if (!content_infos_dup)
{
LOG_MSG("Failed to allocate memory for NcmContentInfo duplicates!");
goto end;
}
/* Copy NcmContentInfo data. */
memcpy(content_infos_dup, title_info->content_infos, title_info->content_count * sizeof(NcmContentInfo));
/* Update content infos pointer. */
title_info_dup->content_infos = content_infos_dup;
/* Duplicate linked list data. */
if (title_info->parent)
{
if (parent)
{
title_info_dup->parent = parent;
} else {
title_info_dup->parent = titleDuplicateTitleInfo(title_info->parent, NULL, NULL, NULL);
if (!title_info_dup->parent) goto end;
dup_parent = true;
}
/* Update pointer to parent title info - this will be used while duplicating siblings. */
parent = title_info_dup->parent;
}
if (title_info->previous)
{
if (previous)
{
title_info_dup->previous = previous;
} else {
title_info_dup->previous = titleDuplicateTitleInfo(title_info->previous, parent, NULL, title_info_dup);
if (!title_info_dup->previous) goto end;
dup_previous = true;
}
}
if (title_info->next)
{
if (next)
{
title_info_dup->next = next;
} else {
title_info_dup->next = titleDuplicateTitleInfo(title_info->next, parent, title_info_dup, NULL);
if (!title_info_dup->next) goto end;
dup_next = true;
}
}
/* Update flag. */
success = true;
end:
/* We can't directly use titleFreeTitleInfo() on title_info_dup because some or all of the linked list data may have been provided as function arguments. */
/* So we'll take care of freeing data the old fashioned way. */
if (!success)
{
if (content_infos_dup)
{
free(content_infos_dup);
content_infos_dup = NULL;
}
if (title_info_dup)
{
/* Free parent linked list (if duplicated). */
/* Parent title infos are user applications with no reference to child titles, so it should be safe to free them first with titleFreeTitleInfo(). */
if (dup_parent) titleFreeTitleInfo(&(title_info_dup->parent));
/* Free previous sibling(s) (if duplicated). */
/* We need to take care not to free the parent linked list, either because we may have already freed it, or because it may have been passed as an argument. */
/* Furthermore, the "next" pointer from the previous sibling points to our current duplicated entry, so we need to clear it. */
if (dup_previous)
{
tmp1 = title_info_dup->previous;
while(tmp1)
{
tmp2 = tmp1->previous;
tmp1->parent = tmp1->previous = tmp1->next = NULL;
titleFreeTitleInfo(&tmp1);
tmp1 = tmp2;
}
}
/* Free next sibling(s) (if duplicated). */
/* We need to take care not to free the parent linked list, either because we may have already freed it, or because it may have been passed as an argument. */
/* Furthermore, the "previous" pointer from the next sibling points to our current duplicated entry, so we need to clear it. */
if (dup_next)
{
tmp1 = title_info_dup->next;
while(tmp1)
{
tmp2 = tmp1->next;
tmp1->parent = tmp1->previous = tmp1->next = NULL;
titleFreeTitleInfo(&tmp1);
tmp1 = tmp2;
}
}
free(title_info_dup);
title_info_dup = NULL;
}
}
return title_info_dup;
}
static int titleSystemTitleMetadataEntrySortFunction(const void *a, const void *b)
{
const TitleApplicationMetadata *app_metadata_1 = *((const TitleApplicationMetadata**)a);
const TitleApplicationMetadata *app_metadata_2 = *((const TitleApplicationMetadata**)b);
if (app_metadata_1->title_id < app_metadata_2->title_id)
{
return -1;
} else
if (app_metadata_1->title_id > app_metadata_2->title_id)
{
return 1;
}
return 0;
}
static int titleUserApplicationMetadataEntrySortFunction(const void *a, const void *b)
{
const TitleApplicationMetadata *app_metadata_1 = *((const TitleApplicationMetadata**)a);
const TitleApplicationMetadata *app_metadata_2 = *((const TitleApplicationMetadata**)b);
return strcasecmp(app_metadata_1->lang_entry.name, app_metadata_2->lang_entry.name);
}
static int titleOrphanTitleInfoSortFunction(const void *a, const void *b)
{
const TitleInfo *title_info_1 = *((const TitleInfo**)a);
const TitleInfo *title_info_2 = *((const TitleInfo**)b);
if (title_info_1->meta_key.id < title_info_2->meta_key.id)
{
return -1;
} else
if (title_info_1->meta_key.id > title_info_2->meta_key.id)
{
return 1;
}
return 0;
}
static char *titleGetPatchVersionString(TitleInfo *title_info)
{
NcmContentInfo *nacp_content = NULL;
u8 storage_id = 0, hfs_partition_type = 0;
NcaContext *nca_ctx = NULL;
NacpContext nacp_ctx = {0};
char display_version[0x11] = {0}, *str = NULL;
if (!title_info || title_info->meta_key.type != NcmContentMetaType_Patch || !(nacp_content = titleGetContentInfoByTypeAndIdOffset(title_info, NcmContentType_Control, 0)))
{
LOG_MSG("Invalid parameters!");
goto end;
}
/* Update parameters. */
storage_id = title_info->storage_id;
if (storage_id == NcmStorageId_GameCard) hfs_partition_type = GameCardHashFileSystemPartitionType_Secure;
/* Allocate memory for the NCA context. */
nca_ctx = calloc(1, sizeof(NcaContext));
if (!nca_ctx)
{
LOG_MSG("Failed to allocate memory for NCA context!");
goto end;
}
/* Initialize NCA context. */
if (!ncaInitializeContext(nca_ctx, storage_id, hfs_partition_type, nacp_content, NULL))
{
LOG_MSG("Failed to initialize NCA context for Control NCA from %016lX!", title_info->meta_key.id);
goto end;
}
/* Initialize NACP context. */
if (!nacpInitializeContext(&nacp_ctx, nca_ctx))
{
LOG_MSG("Failed to initialize NACP context for %016lX!", title_info->meta_key.id);
goto end;
}
/* Get trimmed version string. */
snprintf(display_version, sizeof(display_version), "%s", nacp_ctx.data->display_version);
utilsTrimString(display_version);
/* Check version string length. */
if (!*display_version)
{
LOG_MSG("Display version string from %016lX is empty!", title_info->meta_key.id);
goto end;
}
/* Duplicate version string. */
str = strdup(display_version);
if (!str) LOG_MSG("Failed to duplicate version string from %016lX!", title_info->meta_key.id);
end:
nacpFreeContext(&nacp_ctx);
if (nca_ctx) free(nca_ctx);
return str;
}