// Copyright 2014 Dolphin Emulator Project // SPDX-License-Identifier: GPL-2.0-or-later #include "UICommon/UICommon.h" #include #include #include #include #include #include #include #ifdef _WIN32 #include // for SHGetFolderPath #include #endif #include #include "Common/Common.h" #include "Common/CommonPaths.h" #include "Common/Config/Config.h" #include "Common/FileUtil.h" #include "Common/IniFile.h" #include "Common/Logging/LogManager.h" #include "Common/MathUtil.h" #include "Common/MsgHandler.h" #include "Common/StringUtil.h" #include "Core/Config/MainSettings.h" #include "Core/ConfigLoaders/BaseConfigLoader.h" #include "Core/ConfigManager.h" #include "Core/Core.h" #include "Core/FreeLookManager.h" #include "Core/HW/GBAPad.h" #include "Core/HW/GCKeyboard.h" #include "Core/HW/GCPad.h" #include "Core/HW/ProcessorInterface.h" #include "Core/HW/Wiimote.h" #include "Core/HotkeyManager.h" #include "Core/IOS/IOS.h" #include "Core/IOS/STM/STM.h" #include "Core/System.h" #include "Core/WiiRoot.h" #include "InputCommon/ControllerInterface/ControllerInterface.h" #include "InputCommon/GCAdapter.h" #include "UICommon/DiscordPresence.h" #include "UICommon/USBUtils.h" #ifdef HAVE_X11 #include "UICommon/X11Utils.h" #endif #ifdef __APPLE__ #include #endif #include "VideoCommon/VideoBackendBase.h" namespace UICommon { static Config::ConfigChangedCallbackID s_config_changed_callback_id; static void CreateDumpPath(std::string path) { if (!path.empty()) File::SetUserPath(D_DUMP_IDX, std::move(path)); File::CreateFullPath(File::GetUserPath(D_DUMPAUDIO_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPDSP_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPSSL_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPFRAMES_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPOBJECTS_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPTEXTURES_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPDEBUG_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPDEBUG_BRANCHWATCH_IDX)); } static void CreateLoadPath(std::string path) { if (!path.empty()) File::SetUserPath(D_LOAD_IDX, std::move(path)); File::CreateFullPath(File::GetUserPath(D_HIRESTEXTURES_IDX)); File::CreateFullPath(File::GetUserPath(D_RIIVOLUTION_IDX)); File::CreateFullPath(File::GetUserPath(D_GRAPHICSMOD_IDX)); File::CreateFullPath(File::GetUserPath(D_DYNAMICINPUT_IDX)); } static void CreateResourcePackPath(std::string path) { if (!path.empty()) File::SetUserPath(D_RESOURCEPACK_IDX, std::move(path)); } static void CreateWFSPath(const std::string& path) { if (!path.empty()) File::SetUserPath(D_WFSROOT_IDX, path + '/'); } static void InitCustomPaths() { File::SetUserPath(D_WIIROOT_IDX, Config::Get(Config::MAIN_FS_PATH)); CreateLoadPath(Config::Get(Config::MAIN_LOAD_PATH)); CreateDumpPath(Config::Get(Config::MAIN_DUMP_PATH)); CreateResourcePackPath(Config::Get(Config::MAIN_RESOURCEPACK_PATH)); CreateWFSPath(Config::Get(Config::MAIN_WFS_PATH)); File::SetUserPath(F_WIISDCARDIMAGE_IDX, Config::Get(Config::MAIN_WII_SD_CARD_IMAGE_PATH)); File::SetUserPath(D_WIISDCARDSYNCFOLDER_IDX, Config::Get(Config::MAIN_WII_SD_CARD_SYNC_FOLDER_PATH)); File::CreateFullPath(File::GetUserPath(D_WIISDCARDSYNCFOLDER_IDX)); #ifdef HAS_LIBMGBA File::SetUserPath(F_GBABIOS_IDX, Config::Get(Config::MAIN_GBA_BIOS_PATH)); File::SetUserPath(D_GBASAVES_IDX, Config::Get(Config::MAIN_GBA_SAVES_PATH)); File::CreateFullPath(File::GetUserPath(D_GBASAVES_IDX)); #endif } static void RefreshConfig() { Common::SetEnableAlert(Config::Get(Config::MAIN_USE_PANIC_HANDLERS)); Common::SetAbortOnPanicAlert(Config::Get(Config::MAIN_ABORT_ON_PANIC_ALERT)); } void Init() { Core::RestoreWiiSettings(Core::RestoreReason::CrashRecovery); Config::Init(); Config::AddConfigChangedCallback(InitCustomPaths); Config::AddLayer(ConfigLoaders::GenerateBaseConfigLoader()); SConfig::Init(); Discord::Init(); Common::Log::LogManager::Init(); VideoBackendBase::ActivateBackend(Config::Get(Config::MAIN_GFX_BACKEND)); s_config_changed_callback_id = Config::AddConfigChangedCallback(RefreshConfig); RefreshConfig(); } void Shutdown() { Config::RemoveConfigChangedCallback(s_config_changed_callback_id); GCAdapter::Shutdown(); WiimoteReal::Shutdown(); Common::Log::LogManager::Shutdown(); Discord::Shutdown(); SConfig::Shutdown(); Config::Shutdown(); } void InitControllers(const WindowSystemInfo& wsi) { if (g_controller_interface.IsInit()) return; g_controller_interface.Initialize(wsi); if (!g_controller_interface.HasDefaultDevice()) { // Note that the CI default device could be still temporarily removed at any time WARN_LOG_FMT(CONTROLLERINTERFACE, "No default device has been added in time. Premade control " "mappings intended for the default device may not work."); } GCAdapter::Init(); Pad::Initialize(); Pad::InitializeGBA(); Keyboard::Initialize(); Wiimote::Initialize(Wiimote::InitializeMode::DO_NOT_WAIT_FOR_WIIMOTES); HotkeyManagerEmu::Initialize(); FreeLook::Initialize(); } void ShutdownControllers() { Pad::Shutdown(); Pad::ShutdownGBA(); Keyboard::Shutdown(); Wiimote::Shutdown(); HotkeyManagerEmu::Shutdown(); FreeLook::Shutdown(); g_controller_interface.Shutdown(); } void SetLocale(std::string locale_name) { auto set_locale = [](const std::string& locale) { #ifdef __linux__ std::string adjusted_locale = locale; if (!locale.empty()) adjusted_locale += ".UTF-8"; #else const std::string& adjusted_locale = locale; #endif // setlocale sets the C locale, and global sets the C and C++ locales, so the call to setlocale // would be redundant if it wasn't for not having any other good way to check whether // the locale name is valid. (Constructing a std::locale object for an unsupported // locale name throws std::runtime_error, and exception handling is disabled in Dolphin.) if (!std::setlocale(LC_ALL, adjusted_locale.c_str())) return false; std::locale::global(std::locale(adjusted_locale)); return true; }; #ifdef _WIN32 constexpr char PREFERRED_SEPARATOR = '-'; constexpr char OTHER_SEPARATOR = '_'; #else constexpr char PREFERRED_SEPARATOR = '_'; constexpr char OTHER_SEPARATOR = '-'; #endif // Users who use a system language other than English are unlikely to prefer American date and // time formats, so let's explicitly request "en_GB" if Dolphin's language is set to "en". // (The settings window only allows setting "en", not anything like "en_US" or "en_GB".) // Users who prefer the American formats are likely to have their system language set to en_US, // and are thus likely to leave Dolphin's language as the default value "" (). if (locale_name == "en") locale_name = "en_GB"; std::replace(locale_name.begin(), locale_name.end(), OTHER_SEPARATOR, PREFERRED_SEPARATOR); // Use the specified locale if supported. if (set_locale(locale_name)) return; // Remove subcodes until we get a supported locale. If that doesn't give us a supported locale, // "" is passed to set_locale in order to get the system default locale. while (!locale_name.empty()) { const size_t separator_index = locale_name.rfind(PREFERRED_SEPARATOR); locale_name.erase(separator_index == std::string::npos ? 0 : separator_index); if (set_locale(locale_name)) return; } // If none of the locales tried above are supported, we just keep using whatever locale is set // (which is the classic locale by default). } void CreateDirectories() { File::CreateFullPath(File::GetUserPath(D_RESOURCEPACK_IDX)); File::CreateFullPath(File::GetUserPath(D_USER_IDX)); File::CreateFullPath(File::GetUserPath(D_CACHE_IDX)); File::CreateFullPath(File::GetUserPath(D_COVERCACHE_IDX)); File::CreateFullPath(File::GetUserPath(D_CONFIG_IDX)); File::CreateFullPath(File::GetUserPath(D_CONFIG_IDX) + GRAPHICSMOD_CONFIG_DIR DIR_SEP); File::CreateFullPath(File::GetUserPath(D_DUMPDSP_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPSSL_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPTEXTURES_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPDEBUG_IDX)); File::CreateFullPath(File::GetUserPath(D_DUMPDEBUG_BRANCHWATCH_IDX)); File::CreateFullPath(File::GetUserPath(D_GAMESETTINGS_IDX)); File::CreateFullPath(File::GetUserPath(D_GCUSER_IDX)); File::CreateFullPath(File::GetUserPath(D_GCUSER_IDX) + USA_DIR DIR_SEP); File::CreateFullPath(File::GetUserPath(D_GCUSER_IDX) + EUR_DIR DIR_SEP); File::CreateFullPath(File::GetUserPath(D_GCUSER_IDX) + JAP_DIR DIR_SEP); File::CreateFullPath(File::GetUserPath(D_HIRESTEXTURES_IDX)); File::CreateFullPath(File::GetUserPath(D_GRAPHICSMOD_IDX)); File::CreateFullPath(File::GetUserPath(D_MAILLOGS_IDX)); File::CreateFullPath(File::GetUserPath(D_MAPS_IDX)); File::CreateFullPath(File::GetUserPath(D_SCREENSHOTS_IDX)); File::CreateFullPath(File::GetUserPath(D_SHADERS_IDX)); File::CreateFullPath(File::GetUserPath(D_SHADERS_IDX) + ANAGLYPH_DIR DIR_SEP); File::CreateFullPath(File::GetUserPath(D_STATESAVES_IDX)); File::CreateFullPath(File::GetUserPath(D_ASM_ROOT_IDX)); #ifndef ANDROID File::CreateFullPath(File::GetUserPath(D_THEMES_IDX)); File::CreateFullPath(File::GetUserPath(D_STYLES_IDX)); #else // Disable media scanning in directories with a .nomedia file File::CreateEmptyFile(File::GetUserPath(D_COVERCACHE_IDX) + DIR_SEP NOMEDIA_FILE); #endif } void SetUserDirectory(std::string custom_path) { if (!custom_path.empty()) { File::CreateFullPath(custom_path + DIR_SEP); File::SetUserPath(D_USER_IDX, std::move(custom_path)); return; } std::string user_path; #ifdef _WIN32 // Detect where the User directory is. There are five different cases // (on top of the command line flag, which overrides all this): // 1. GetExeDirectory()\portable.txt exists // -> Use GetExeDirectory()\User // 2. HKCU\Software\Dolphin Emulator\LocalUserConfig exists and is true // -> Use GetExeDirectory()\User // 3. HKCU\Software\Dolphin Emulator\UserConfigPath exists // -> Use this as the user directory path // 4. My Documents\Dolphin Emulator exists (default user folder before PR 10708) // -> Use this as the user directory path // 5. AppData\Roaming exists // -> Use AppData\Roaming\Dolphin Emulator as the User directory path // 6. Default // -> Use GetExeDirectory()\User // // On Steam builds, we take a simplified approach: // 1. GetExeDirectory()\portable.txt exists // -> Use GetExeDirectory()\User // 2. AppData\Roaming exists // -> Use AppData\Roaming\Dolphin Emulator (Steam) as the User directory path // 3. Default // -> Use GetExeDirectory()\User // Get AppData path in case we need it. wil::unique_cotaskmem_string appdata; bool appdata_found = SUCCEEDED( SHGetKnownFolderPath(FOLDERID_RoamingAppData, KF_FLAG_DEFAULT, nullptr, appdata.put())); #ifndef STEAM // Check our registry keys wil::unique_hkey hkey; DWORD local = 0; std::unique_ptr configPath; if (RegOpenKeyEx(HKEY_CURRENT_USER, TEXT("Software\\Dolphin Emulator"), 0, KEY_QUERY_VALUE, hkey.put()) == ERROR_SUCCESS) { DWORD size = sizeof(local); if (RegQueryValueEx(hkey.get(), TEXT("LocalUserConfig"), nullptr, nullptr, reinterpret_cast(&local), &size) != ERROR_SUCCESS) { local = 0; } size = 0; RegQueryValueEx(hkey.get(), TEXT("UserConfigPath"), nullptr, nullptr, nullptr, &size); configPath = std::make_unique(size / sizeof(TCHAR)); if (RegQueryValueEx(hkey.get(), TEXT("UserConfigPath"), nullptr, nullptr, reinterpret_cast(configPath.get()), &size) != ERROR_SUCCESS) { configPath.reset(); } } local = local != 0 || File::Exists(File::GetExeDirectory() + DIR_SEP "portable.txt"); // Attempt to check if the old User directory exists in Documents. wil::unique_cotaskmem_string documents; bool documents_found = SUCCEEDED( SHGetKnownFolderPath(FOLDERID_Documents, KF_FLAG_DEFAULT, nullptr, documents.put())); std::optional old_user_folder; if (documents_found) { old_user_folder = TStrToUTF8(documents.get()) + DIR_SEP NORMAL_USER_DIR DIR_SEP; } if (local) // Case 1-2 { user_path = File::GetExeDirectory() + DIR_SEP PORTABLE_USER_DIR DIR_SEP; } else if (configPath) // Case 3 { user_path = TStrToUTF8(configPath.get()); } else if (old_user_folder && File::Exists(old_user_folder.value())) // Case 4 { user_path = old_user_folder.value(); } else if (appdata_found) // Case 5 { user_path = TStrToUTF8(appdata.get()) + DIR_SEP NORMAL_USER_DIR DIR_SEP; // Set the UserConfigPath value in the registry for backwards compatibility with older Dolphin // builds, which will look for the default User directory in Documents. If we set this key, // they will use this as the User directory instead. // (If we're in this case, then this key doesn't exist, so it's OK to set it.) std::wstring wstr_path = UTF8ToWString(user_path); RegSetKeyValueW(HKEY_CURRENT_USER, TEXT("Software\\Dolphin Emulator"), TEXT("UserConfigPath"), REG_SZ, wstr_path.c_str(), static_cast((wstr_path.size() + 1) * sizeof(wchar_t))); } else // Case 6 { user_path = File::GetExeDirectory() + DIR_SEP PORTABLE_USER_DIR DIR_SEP; } #else // ifndef STEAM if (File::Exists(File::GetExeDirectory() + DIR_SEP "portable.txt")) // Case 1 { user_path = File::GetExeDirectory() + DIR_SEP PORTABLE_USER_DIR DIR_SEP; } else if (appdata_found) // Case 2 { user_path = TStrToUTF8(appdata.get()) + DIR_SEP NORMAL_USER_DIR DIR_SEP; } else // Case 3 { user_path = File::GetExeDirectory() + DIR_SEP PORTABLE_USER_DIR DIR_SEP; } #endif #else if (File::IsDirectory(ROOT_DIR DIR_SEP EMBEDDED_USER_DIR)) { user_path = ROOT_DIR DIR_SEP EMBEDDED_USER_DIR DIR_SEP; } else { const char* env_path = getenv("DOLPHIN_EMU_USERPATH"); const char* home = getenv("HOME"); if (!home) home = getenv("PWD"); if (!home) home = ""; std::string home_path = std::string(home) + DIR_SEP; // On a non-Apple and non-Android POSIX system, there are 4 cases: // 1. GetExeDirectory()/portable.txt exists // -> Use GetExeDirectory()/User // 2. $DOLPHIN_EMU_USERPATH is set // -> Use $DOLPHIN_EMU_USERPATH // 3. ~/.dolphin-emu directory exists // -> Use ~/.dolphin-emu // 4. Default // -> Use XDG basedir, see // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html // // On macOS: // 1. GetExeDirectory()/portable.txt exists // -> Use GetExeDirectory()/User // 2. $DOLPHIN_EMU_USERPATH is set // -> Use $DOLPHIN_EMU_USERPATH // 3. Default // // On Android, custom_path is set, so this code path is never reached. std::string exe_path = File::GetExeDirectory(); if (File::Exists(exe_path + DIR_SEP "portable.txt")) { user_path = exe_path + DIR_SEP PORTABLE_USER_DIR DIR_SEP; } else if (env_path) { user_path = env_path; } #if defined(__APPLE__) || defined(ANDROID) else { user_path = home_path + NORMAL_USER_DIR DIR_SEP; } #else else { user_path = home_path + "." NORMAL_USER_DIR DIR_SEP; if (!File::Exists(user_path)) { const char* data_home = getenv("XDG_DATA_HOME"); std::string data_path = std::string(data_home && data_home[0] == '/' ? data_home : (home_path + ".local" DIR_SEP "share")) + DIR_SEP NORMAL_USER_DIR DIR_SEP; const char* config_home = getenv("XDG_CONFIG_HOME"); std::string config_path = std::string(config_home && config_home[0] == '/' ? config_home : (home_path + ".config")) + DIR_SEP NORMAL_USER_DIR DIR_SEP; const char* cache_home = getenv("XDG_CACHE_HOME"); std::string cache_path = std::string(cache_home && cache_home[0] == '/' ? cache_home : (home_path + ".cache")) + DIR_SEP NORMAL_USER_DIR DIR_SEP; File::SetUserPath(D_USER_IDX, data_path); File::SetUserPath(D_CONFIG_IDX, config_path); File::SetUserPath(D_CACHE_IDX, cache_path); return; } } #endif } #endif File::SetUserPath(D_USER_IDX, std::move(user_path)); } bool TriggerSTMPowerEvent() { const auto ios = Core::System::GetInstance().GetIOS(); if (!ios) return false; const auto stm = ios->GetDeviceByName("/dev/stm/eventhook"); if (!stm || !std::static_pointer_cast(stm)->HasHookInstalled()) return false; Core::DisplayMessage("Shutting down", 30000); ios->GetSystem().GetProcessorInterface().PowerButton_Tap(); return true; } #ifdef HAVE_X11 void InhibitScreenSaver(Window win, bool inhibit) #else void InhibitScreenSaver(bool inhibit) #endif { // Inhibit the screensaver. Depending on the operating system this may also // disable low-power states and/or screen dimming. #ifdef HAVE_X11 X11Utils::InhibitScreensaver(win, inhibit); #endif #ifdef _WIN32 // Prevents Windows from sleeping, turning off the display, or idling SetThreadExecutionState(ES_CONTINUOUS | (inhibit ? (ES_DISPLAY_REQUIRED | ES_SYSTEM_REQUIRED) : 0)); #endif #ifdef __APPLE__ static IOPMAssertionID s_power_assertion = kIOPMNullAssertionID; if (inhibit) { CFStringRef reason_for_activity = CFSTR("Emulation Running"); if (IOPMAssertionCreateWithName(kIOPMAssertionTypePreventUserIdleDisplaySleep, kIOPMAssertionLevelOn, reason_for_activity, &s_power_assertion) != kIOReturnSuccess) { s_power_assertion = kIOPMNullAssertionID; } } else { if (s_power_assertion != kIOPMNullAssertionID) { IOPMAssertionRelease(s_power_assertion); s_power_assertion = kIOPMNullAssertionID; } } #endif } std::string FormatSize(u64 bytes, int decimals) { // i18n: The symbol for the unit "bytes" const char* const unit_symbols[] = {_trans("B"), _trans("KiB"), _trans("MiB"), _trans("GiB"), _trans("TiB"), _trans("PiB"), _trans("EiB")}; // Find largest power of 2 less than size. // div 10 to get largest named unit less than size // 10 == log2(1024) (number of B in a KiB, KiB in a MiB, etc) // Max value is 63 / 10 = 6 const int unit = MathUtil::IntLog2(std::max(bytes, 1)) / 10; // Don't need exact values, only 5 most significant digits const double unit_size = std::pow(2, unit * 10); return fmt::format("{:.{}Lf} {}", bytes / unit_size, decimals, Common::GetStringT(unit_symbols[unit])); } } // namespace UICommon