#include "achievements.h"
#include "achievements_private.h"
#include "bios.h"
#include "bus.h"
#include "cheats.h"
#include "cpu_core.h"
#include "fullscreen_ui.h"
#include "game_list.h"
#include "gpu_thread.h"
#include "host.h"
#include "imgui_overlays.h"
#include "system.h"
#include "scmversion/scmversion.h"
#include "common/assert.h"
#include "common/binary_reader_writer.h"
#include "common/error.h"
#include "common/file_system.h"
#include "common/heap_array.h"
#include "common/log.h"
#include "common/md5_digest.h"
#include "common/path.h"
#include "common/ryml_helpers.h"
#include "common/scoped_guard.h"
#include "common/sha256_digest.h"
#include "common/small_string.h"
#include "common/string_util.h"
#include "common/timer.h"
#include "util/cd_image.h"
#include "util/http_downloader.h"
#include "util/imgui_fullscreen.h"
#include "util/imgui_manager.h"
#include "util/platform_misc.h"
#include "util/state_wrapper.h"
#include "IconsEmoji.h"
#include "IconsFontAwesome6.h"
#include "IconsPromptFont.h"
#include "fmt/format.h"
#include "imgui.h"
#include "imgui_internal.h"
#include "rc_api_runtime.h"
#include "rc_client.h"
#include "rc_consoles.h"
#include <algorithm>
#include <atomic>
#include <cstdarg>
#include <cstdlib>
#include <ctime>
#include <functional>
#include <string>
#include <unordered_set>
#include <vector>
LOG_CHANNEL(Achievements);
namespace Achievements {
static constexpr const char* INFO_SOUND_NAME = "sounds/achievements/message.wav";
static constexpr const char* UNLOCK_SOUND_NAME = "sounds/achievements/unlock.wav";
static constexpr const char* LBSUBMIT_SOUND_NAME = "sounds/achievements/lbsubmit.wav";
static constexpr const char* ACHEIVEMENT_DETAILS_URL_TEMPLATE = "https://retroachievements.org/achievement/{}";
static constexpr const char* PROFILE_DETAILS_URL_TEMPLATE = "https://retroachievements.org/user/{}";
static constexpr const char* CACHE_SUBDIRECTORY_NAME = "achievement_images";
static constexpr u32 LEADERBOARD_NEARBY_ENTRIES_TO_FETCH = 10;
static constexpr u32 LEADERBOARD_ALL_FETCH_SIZE = 20;
static constexpr float LOGIN_NOTIFICATION_TIME = 5.0f;
static constexpr float ACHIEVEMENT_SUMMARY_NOTIFICATION_TIME = 5.0f;
static constexpr float ACHIEVEMENT_SUMMARY_NOTIFICATION_TIME_HC = 10.0f;
static constexpr float ACHIEVEMENT_SUMMARY_UNSUPPORTED_TIME = 12.0f;
static constexpr float GAME_COMPLETE_NOTIFICATION_TIME = 20.0f;
static constexpr float CHALLENGE_STARTED_NOTIFICATION_TIME = 5.0f;
static constexpr float CHALLENGE_FAILED_NOTIFICATION_TIME = 5.0f;
static constexpr float LEADERBOARD_STARTED_NOTIFICATION_TIME = 3.0f;
static constexpr float LEADERBOARD_FAILED_NOTIFICATION_TIME = 3.0f;
static constexpr float INDICATOR_FADE_IN_TIME = 0.1f;
static constexpr float INDICATOR_FADE_OUT_TIME = 0.3f;
static constexpr float PAUSE_MENU_PROGRESS_DISPLAY_TIME = 60.0f;
static constexpr float SERVER_CALL_TIMEOUT = 60.0f;
static constexpr u32 MAX_CONCURRENT_SERVER_CALLS = 10;
namespace {
struct LoginWithPasswordParameters
{
const char* username;
Error* error;
rc_client_async_handle_t* request;
bool result;
};
struct LeaderboardTrackerIndicator
{
u32 tracker_id;
std::string text;
float opacity;
bool active;
};
struct AchievementChallengeIndicator
{
const rc_client_achievement_t* achievement;
std::string badge_path;
float time_remaining;
float opacity;
bool active;
};
struct AchievementProgressIndicator
{
const rc_client_achievement_t* achievement;
std::string badge_path;
float opacity;
bool active;
};
struct PauseMenuAchievementInfo
{
std::string title;
std::string description;
std::string badge_path;
u32 achievement_id;
float measured_percent;
};
struct PauseMenuMeasuredAchievementInfo : PauseMenuAchievementInfo
{
std::string measured_progress;
};
struct PauseMenuTimedMeasuredAchievementInfo : PauseMenuMeasuredAchievementInfo
{
Timer::Value show_time;
};
}
static TinyString GameHashToString(const std::optional<GameHash>& hash);
static void ReportError(std::string_view sv);
template<typename... T>
static void ReportFmtError(fmt::format_string<T...> fmt, T&&... args);
template<typename... T>
static void ReportRCError(int err, fmt::format_string<T...> fmt, T&&... args);
static void ClearGameInfo();
static void ClearGameHash();
static bool HasSavedCredentials();
static bool TryLoggingInWithToken();
static void EnableHardcodeMode(bool display_message, bool display_game_summary);
static void OnHardcoreModeChanged(bool enabled, bool display_message, bool display_game_summary);
static bool IsRAIntegrationInitializing();
static void FinishInitialize();
static void FinishLogin(const rc_client_t* client);
static void ShowLoginNotification();
static bool IdentifyGame(CDImage* image);
static bool IdentifyCurrentGame();
static void BeginLoadGame();
static void UpdateGameSummary(bool update_progress_database);
static std::string GetImageURL(const char* image_name, u32 type);
static std::string GetLocalImagePath(const std::string_view image_name, u32 type);
static void DownloadImage(std::string url, std::string cache_path);
static const std::string& GetCachedAchievementBadgePath(const rc_client_achievement_t* achievement, bool locked);
template<typename T>
static void CachePauseMenuAchievementInfo(const rc_client_achievement_t* achievement, std::optional<T>& value);
static TinyString DecryptLoginToken(std::string_view encrypted_token, std::string_view username);
static TinyString EncryptLoginToken(std::string_view token, std::string_view username);
static bool CreateClient(rc_client_t** client, std::unique_ptr<HTTPDownloader>* http);
static void DestroyClient(rc_client_t** client, std::unique_ptr<HTTPDownloader>* http);
static void ClientMessageCallback(const char* message, const rc_client_t* client);
static uint32_t ClientReadMemory(uint32_t address, uint8_t* buffer, uint32_t num_bytes, rc_client_t* client);
static void ClientServerCall(const rc_api_request_t* request, rc_client_server_callback_t callback, void* callback_data,
rc_client_t* client);
static void ClientEventHandler(const rc_client_event_t* event, rc_client_t* client);
static void HandleResetEvent(const rc_client_event_t* event);
static void HandleUnlockEvent(const rc_client_event_t* event);
static void HandleGameCompleteEvent(const rc_client_event_t* event);
static void HandleSubsetCompleteEvent(const rc_client_event_t* event);
static void HandleLeaderboardStartedEvent(const rc_client_event_t* event);
static void HandleLeaderboardFailedEvent(const rc_client_event_t* event);
static void HandleLeaderboardSubmittedEvent(const rc_client_event_t* event);
static void HandleLeaderboardScoreboardEvent(const rc_client_event_t* event);
static void HandleLeaderboardTrackerShowEvent(const rc_client_event_t* event);
static void HandleLeaderboardTrackerHideEvent(const rc_client_event_t* event);
static void HandleLeaderboardTrackerUpdateEvent(const rc_client_event_t* event);
static void HandleAchievementChallengeIndicatorShowEvent(const rc_client_event_t* event);
static void HandleAchievementChallengeIndicatorHideEvent(const rc_client_event_t* event);
static void HandleAchievementProgressIndicatorShowEvent(const rc_client_event_t* event);
static void HandleAchievementProgressIndicatorHideEvent(const rc_client_event_t* event);
static void HandleAchievementProgressIndicatorUpdateEvent(const rc_client_event_t* event);
static void HandleServerErrorEvent(const rc_client_event_t* event);
static void HandleServerDisconnectedEvent(const rc_client_event_t* event);
static void HandleServerReconnectedEvent(const rc_client_event_t* event);
static void ClientLoginWithTokenCallback(int result, const char* error_message, rc_client_t* client, void* userdata);
static void ClientLoginWithPasswordCallback(int result, const char* error_message, rc_client_t* client, void* userdata);
static void ClientLoadGameCallback(int result, const char* error_message, rc_client_t* client, void* userdata);
static void DisplayHardcoreDeferredMessage();
static void DisplayAchievementSummary();
static void UpdateRichPresence(std::unique_lock<std::recursive_mutex>& lock);
static void LeaderboardFetchNearbyCallback(int result, const char* error_message,
rc_client_leaderboard_entry_list_t* list, rc_client_t* client,
void* callback_userdata);
static void LeaderboardFetchAllCallback(int result, const char* error_message, rc_client_leaderboard_entry_list_t* list,
rc_client_t* client, void* callback_userdata);
#ifndef __ANDROID__
static void DrawAchievement(const rc_client_achievement_t* cheevo);
static void DrawLeaderboardListEntry(const rc_client_leaderboard_t* lboard);
static void DrawLeaderboardEntry(const rc_client_leaderboard_entry_t& entry, u32 index, bool is_self,
float rank_column_width, float name_column_width, float time_column_width,
float column_spacing);
#endif
static std::string GetHashDatabasePath();
static std::string GetProgressDatabasePath();
static void PreloadHashDatabase();
static bool LoadHashDatabase(const std::string& path, Error* error);
static bool CreateHashDatabaseFromSeedDatabase(const std::string& path, Error* error);
static void BeginRefreshHashDatabase();
static void FinishRefreshHashDatabase();
static void CancelHashDatabaseRequests();
static void FetchHashLibraryCallback(int result, const char* error_message, rc_client_hash_library_t* list,
rc_client_t* client, void* callback_userdata);
static void FetchAllProgressCallback(int result, const char* error_message, rc_client_all_user_progress_t* list,
rc_client_t* client, void* callback_userdata);
static void RefreshAllProgressCallback(int result, const char* error_message, rc_client_all_user_progress_t* list,
rc_client_t* client, void* callback_userdata);
static void BuildHashDatabase(const rc_client_hash_library_t* hashlib, const rc_client_all_user_progress_t* allprog);
static bool SortAndSaveHashDatabase(Error* error);
static FileSystem::ManagedCFilePtr OpenProgressDatabase(bool for_write, bool truncate, Error* error);
static void BuildProgressDatabase(const rc_client_all_user_progress_t* allprog);
static void UpdateProgressDatabase();
static void ClearProgressDatabase();
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
static void BeginLoadRAIntegration();
static void UnloadRAIntegration();
#endif
namespace {
struct State
{
rc_client_t* client = nullptr;
bool has_achievements = false;
bool has_leaderboards = false;
bool has_rich_presence = false;
std::recursive_mutex mutex;
std::string rich_presence_string;
Timer::Value rich_presence_poll_time = 0;
std::vector<LeaderboardTrackerIndicator> active_leaderboard_trackers;
std::vector<AchievementChallengeIndicator> active_challenge_indicators;
std::optional<AchievementProgressIndicator> active_progress_indicator;
rc_client_user_game_summary_t game_summary = {};
u32 game_id = 0;
std::unique_ptr<HTTPDownloader> http_downloader;
std::string game_path;
std::string game_title;
std::string game_icon;
std::string game_icon_url;
std::optional<GameHash> game_hash;
rc_client_async_handle_t* login_request = nullptr;
rc_client_async_handle_t* load_game_request = nullptr;
rc_client_achievement_list_t* achievement_list = nullptr;
std::vector<std::tuple<const void*, std::string, bool>> achievement_badge_paths;
std::optional<PauseMenuAchievementInfo> most_recent_unlock;
std::optional<PauseMenuMeasuredAchievementInfo> achievement_nearest_completion;
std::optional<PauseMenuTimedMeasuredAchievementInfo> most_recent_progress_update;
rc_client_leaderboard_list_t* leaderboard_list = nullptr;
const rc_client_leaderboard_t* open_leaderboard = nullptr;
rc_client_async_handle_t* leaderboard_fetch_handle = nullptr;
std::vector<rc_client_leaderboard_entry_list_t*> leaderboard_entry_lists;
std::vector<std::pair<const rc_client_leaderboard_entry_t*, std::string>> leaderboard_user_icon_paths;
rc_client_leaderboard_entry_list_t* leaderboard_nearby_entries;
bool is_showing_all_leaderboard_entries = false;
bool hashdb_loaded = false;
std::vector<HashDatabaseEntry> hashdb_entries;
rc_client_async_handle_t* fetch_hash_library_request = nullptr;
rc_client_hash_library_t* fetch_hash_library_result = nullptr;
rc_client_async_handle_t* fetch_all_progress_request = nullptr;
rc_client_all_user_progress_t* fetch_all_progress_result = nullptr;
rc_client_async_handle_t* refresh_all_progress_request = nullptr;
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
rc_client_async_handle_t* load_raintegration_request = nullptr;
bool using_raintegration = false;
bool raintegration_loading = false;
#endif
};
}
ALIGN_TO_CACHE_LINE static State s_state;
}
TinyString Achievements::GameHashToString(const std::optional<GameHash>& hash)
{
TinyString ret;
if (!hash.has_value())
{
ret = "[NO HASH]";
}
else
{
ret.format("{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}",
hash.value()[0], hash.value()[1], hash.value()[2], hash.value()[3], hash.value()[4], hash.value()[5],
hash.value()[6], hash.value()[7], hash.value()[8], hash.value()[9], hash.value()[10], hash.value()[11],
hash.value()[12], hash.value()[13], hash.value()[14], hash.value()[15]);
}
return ret;
}
std::unique_lock<std::recursive_mutex> Achievements::GetLock()
{
return std::unique_lock(s_state.mutex);
}
rc_client_t* Achievements::GetClient()
{
return s_state.client;
}
const rc_client_user_game_summary_t& Achievements::GetGameSummary()
{
return s_state.game_summary;
}
void Achievements::ReportError(std::string_view sv)
{
ERROR_LOG(sv);
Host::AddIconOSDWarning(std::string(), ICON_EMOJI_WARNING, std::string(sv), Host::OSD_CRITICAL_ERROR_DURATION);
}
template<typename... T>
void Achievements::ReportFmtError(fmt::format_string<T...> fmt, T&&... args)
{
TinyString str;
fmt::vformat_to(std::back_inserter(str), fmt, fmt::make_format_args(args...));
ReportError(str);
}
template<typename... T>
void Achievements::ReportRCError(int err, fmt::format_string<T...> fmt, T&&... args)
{
TinyString str;
fmt::vformat_to(std::back_inserter(str), fmt, fmt::make_format_args(args...));
str.append_format("{} ({})", rc_error_str(err), err);
ReportError(str);
}
std::optional<Achievements::GameHash> Achievements::GetGameHash(CDImage* image)
{
std::optional<GameHash> ret;
std::string executable_name;
std::vector<u8> executable_data;
if (!System::ReadExecutableFromImage(image, &executable_name, &executable_data))
return ret;
return GetGameHash(executable_name, executable_data);
}
std::optional<Achievements::GameHash> Achievements::GetGameHash(const std::string_view executable_name,
std::span<const u8> executable_data)
{
std::optional<GameHash> ret;
const BIOS::PSEXEHeader* header = reinterpret_cast<const BIOS::PSEXEHeader*>(executable_data.data());
if (executable_data.size() < sizeof(BIOS::PSEXEHeader) || !BIOS::IsValidPSExeHeader(*header, executable_data.size()))
{
ERROR_LOG("PS-EXE header is invalid in '{}' ({} bytes)", executable_name, executable_data.size());
return ret;
}
const u32 hash_size = std::min(header->file_size + 2048, static_cast<u32>(executable_data.size()));
MD5Digest digest;
digest.Update(executable_name.data(), static_cast<u32>(executable_name.size()));
if (hash_size > 0)
digest.Update(executable_data.data(), hash_size);
ret.emplace();
digest.Final(ret.value());
INFO_COLOR_LOG(StrongOrange, "RA Hash for '{}': {} ({} bytes hashed)", executable_name, GameHashToString(ret),
hash_size);
return ret;
}
std::string Achievements::GetImageURL(const char* image_name, u32 type)
{
std::string ret;
const rc_api_fetch_image_request_t image_request = {.image_name = image_name, .image_type = type};
rc_api_request_t request;
int result = rc_api_init_fetch_image_request(&request, &image_request);
if (result == RC_OK)
ret = request.url;
rc_api_destroy_request(&request);
return ret;
}
std::string Achievements::GetLocalImagePath(const std::string_view image_name, u32 type)
{
std::string_view prefix;
std::string_view suffix;
switch (type)
{
case RC_IMAGE_TYPE_GAME:
prefix = "image";
break;
case RC_IMAGE_TYPE_USER:
prefix = "user";
break;
case RC_IMAGE_TYPE_ACHIEVEMENT:
prefix = "badge";
break;
case RC_IMAGE_TYPE_ACHIEVEMENT_LOCKED:
prefix = "badge";
suffix = "_lock";
break;
default:
prefix = "badge";
break;
}
std::string ret;
if (!image_name.empty())
{
ret = fmt::format("{}" FS_OSPATH_SEPARATOR_STR "{}" FS_OSPATH_SEPARATOR_STR "{}_{}{}.png", EmuFolders::Cache,
CACHE_SUBDIRECTORY_NAME, prefix, Path::SanitizeFileName(image_name), suffix);
}
return ret;
}
void Achievements::DownloadImage(std::string url, std::string cache_path)
{
auto callback = [cache_path = std::move(cache_path)](s32 status_code, const Error& error,
const std::string& content_type,
HTTPDownloader::Request::Data data) mutable {
if (status_code != HTTPDownloader::HTTP_STATUS_OK)
{
ERROR_LOG("Failed to download badge '{}': {}", Path::GetFileName(cache_path), error.GetDescription());
return;
}
Error write_error;
if (!FileSystem::WriteBinaryFile(cache_path.c_str(), data, &write_error))
{
ERROR_LOG("Failed to write badge image to '{}': {}", cache_path, write_error.GetDescription());
return;
}
GPUThread::RunOnThread(
[cache_path = std::move(cache_path)]() { ImGuiFullscreen::InvalidateCachedTexture(cache_path); });
};
s_state.http_downloader->CreateRequest(std::move(url), std::move(callback));
}
bool Achievements::IsActive()
{
return (s_state.client != nullptr);
}
bool Achievements::IsHardcoreModeActive()
{
if (!s_state.client)
return false;
const auto lock = GetLock();
return rc_client_get_hardcore_enabled(s_state.client);
}
bool Achievements::HasActiveGame()
{
return s_state.game_id != 0;
}
u32 Achievements::GetGameID()
{
return s_state.game_id;
}
bool Achievements::HasAchievementsOrLeaderboards()
{
return s_state.has_achievements || s_state.has_leaderboards;
}
bool Achievements::HasAchievements()
{
return s_state.has_achievements;
}
bool Achievements::HasLeaderboards()
{
return s_state.has_leaderboards;
}
bool Achievements::HasRichPresence()
{
return s_state.has_rich_presence;
}
const std::string& Achievements::GetGameTitle()
{
return s_state.game_title;
}
const std::string& Achievements::GetGamePath()
{
return s_state.game_path;
}
const std::string& Achievements::GetGameIconPath()
{
return s_state.game_icon;
}
const std::string& Achievements::GetGameIconURL()
{
return s_state.game_icon_url;
}
const std::string& Achievements::GetRichPresenceString()
{
return s_state.rich_presence_string;
}
bool Achievements::Initialize()
{
auto lock = GetLock();
AssertMsg(g_settings.achievements_enabled, "Achievements are enabled");
Assert(!s_state.client && !s_state.http_downloader);
if (!CreateClient(&s_state.client, &s_state.http_downloader))
return false;
rc_client_set_event_handler(s_state.client, ClientEventHandler);
rc_client_set_allow_background_memory_reads(s_state.client, true);
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
if (g_settings.achievements_use_raintegration)
BeginLoadRAIntegration();
#endif
rc_client_set_hardcore_enabled(s_state.client, false);
rc_client_set_encore_mode_enabled(s_state.client, g_settings.achievements_encore_mode);
rc_client_set_unofficial_enabled(s_state.client, g_settings.achievements_unofficial_test_mode);
rc_client_set_spectator_mode_enabled(s_state.client, g_settings.achievements_spectator_mode);
if (!IsRAIntegrationInitializing())
FinishInitialize();
return true;
}
void Achievements::FinishInitialize()
{
TryLoggingInWithToken();
if (System::IsValid())
{
IdentifyCurrentGame();
BeginLoadGame();
if (IsLoggedInOrLoggingIn() && g_settings.achievements_hardcore_mode)
DisplayHardcoreDeferredMessage();
}
Host::OnAchievementsActiveChanged(true);
}
bool Achievements::CreateClient(rc_client_t** client, std::unique_ptr<HTTPDownloader>* http)
{
rc_client_t* new_client = rc_client_create(ClientReadMemory, ClientServerCall);
if (!new_client)
{
Host::ReportErrorAsync("Achievements Error", "rc_client_create() failed, cannot use achievements");
return false;
}
rc_client_enable_logging(
new_client, (Log::GetLogLevel() >= Log::Level::Verbose) ? RC_CLIENT_LOG_LEVEL_VERBOSE : RC_CLIENT_LOG_LEVEL_INFO,
ClientMessageCallback);
char rc_client_user_agent[128];
rc_client_get_user_agent_clause(new_client, rc_client_user_agent, std::size(rc_client_user_agent));
*http = HTTPDownloader::Create(fmt::format("{} {}", Host::GetHTTPUserAgent(), rc_client_user_agent));
if (!*http)
{
Host::ReportErrorAsync("Achievements Error", "Failed to create HTTPDownloader, cannot use achievements");
rc_client_destroy(new_client);
return false;
}
(*http)->SetTimeout(SERVER_CALL_TIMEOUT);
(*http)->SetMaxActiveRequests(MAX_CONCURRENT_SERVER_CALLS);
rc_client_set_userdata(new_client, http->get());
*client = new_client;
return true;
}
void Achievements::DestroyClient(rc_client_t** client, std::unique_ptr<HTTPDownloader>* http)
{
(*http)->WaitForAllRequests();
rc_client_destroy(*client);
*client = nullptr;
http->reset();
}
bool Achievements::HasSavedCredentials()
{
const TinyString username = Host::GetTinyStringSettingValue("Cheevos", "Username");
const TinyString api_token = Host::GetTinyStringSettingValue("Cheevos", "Token");
return (!username.empty() && !api_token.empty());
}
bool Achievements::TryLoggingInWithToken()
{
const TinyString username = Host::GetTinyStringSettingValue("Cheevos", "Username");
const TinyString api_token = Host::GetTinyStringSettingValue("Cheevos", "Token");
if (username.empty() || api_token.empty())
return false;
INFO_LOG("Attempting token login with user '{}'...", username);
if (const TinyString decrypted_api_token = DecryptLoginToken(api_token, username); !decrypted_api_token.empty())
{
s_state.login_request = rc_client_begin_login_with_token(
s_state.client, username.c_str(), decrypted_api_token.c_str(), ClientLoginWithTokenCallback, nullptr);
if (!s_state.login_request)
{
WARNING_LOG("Creating login request failed.");
return false;
}
return true;
}
else
{
WARNING_LOG("Invalid encrypted login token, requesitng a new one.");
Host::OnAchievementsLoginRequested(LoginRequestReason::TokenInvalid);
return false;
}
}
void Achievements::UpdateSettings(const Settings& old_config)
{
if (!g_settings.achievements_enabled)
{
Shutdown();
return;
}
if (!IsActive())
{
Initialize();
return;
}
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
if (g_settings.achievements_use_raintegration != old_config.achievements_use_raintegration)
{
Shutdown();
Initialize();
return;
}
#endif
if (g_settings.achievements_hardcore_mode != old_config.achievements_hardcore_mode)
{
if (g_settings.achievements_hardcore_mode)
DisplayHardcoreDeferredMessage();
else
DisableHardcoreMode(true, true);
}
auto lock = GetLock();
if (HasActiveGame())
{
lock.unlock();
if (g_settings.achievements_encore_mode != old_config.achievements_encore_mode ||
g_settings.achievements_spectator_mode != old_config.achievements_spectator_mode ||
g_settings.achievements_unofficial_test_mode != old_config.achievements_unofficial_test_mode)
{
Shutdown();
Initialize();
return;
}
}
else
{
if (g_settings.achievements_encore_mode != old_config.achievements_encore_mode)
rc_client_set_encore_mode_enabled(s_state.client, g_settings.achievements_encore_mode);
if (g_settings.achievements_spectator_mode != old_config.achievements_spectator_mode)
rc_client_set_spectator_mode_enabled(s_state.client, g_settings.achievements_spectator_mode);
if (g_settings.achievements_unofficial_test_mode != old_config.achievements_unofficial_test_mode)
rc_client_set_unofficial_enabled(s_state.client, g_settings.achievements_unofficial_test_mode);
}
if (!g_settings.achievements_leaderboard_trackers)
s_state.active_leaderboard_trackers.clear();
if (!g_settings.achievements_progress_indicators)
s_state.active_progress_indicator.reset();
}
void Achievements::Shutdown()
{
if (!IsActive())
return;
auto lock = GetLock();
Assert(s_state.client && s_state.http_downloader);
ClearGameInfo();
ClearGameHash();
DisableHardcoreMode(false, false);
CancelHashDatabaseRequests();
if (s_state.login_request)
{
rc_client_abort_async(s_state.client, s_state.login_request);
s_state.login_request = nullptr;
}
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
if (s_state.using_raintegration)
{
UnloadRAIntegration();
return;
}
#endif
DestroyClient(&s_state.client, &s_state.http_downloader);
Host::OnAchievementsActiveChanged(false);
}
void Achievements::ClientMessageCallback(const char* message, const rc_client_t* client)
{
DEV_LOG(message);
}
uint32_t Achievements::ClientReadMemory(uint32_t address, uint8_t* buffer, uint32_t num_bytes, rc_client_t* client)
{
if ((address + num_bytes) > 0x200400U) [[unlikely]]
return 0;
const u8* src = (address >= 0x200000U) ? CPU::g_state.scratchpad.data() : Bus::g_ram;
const u32 offset = (address & Bus::RAM_2MB_MASK);
switch (num_bytes)
{
case 1:
std::memcpy(buffer, &src[offset], 1);
break;
case 2:
std::memcpy(buffer, &src[offset], 2);
break;
case 4:
std::memcpy(buffer, &src[offset], 4);
break;
default:
[[unlikely]] std::memcpy(buffer, &src[offset], num_bytes);
break;
}
return num_bytes;
}
void Achievements::ClientServerCall(const rc_api_request_t* request, rc_client_server_callback_t callback,
void* callback_data, rc_client_t* client)
{
HTTPDownloader::Request::Callback hd_callback = [callback, callback_data](s32 status_code, const Error& error,
const std::string& content_type,
HTTPDownloader::Request::Data data) {
if (status_code != HTTPDownloader::HTTP_STATUS_OK)
ERROR_LOG("Server call failed: {}", error.GetDescription());
rc_api_server_response_t rr;
rr.http_status_code = (status_code <= 0) ? (status_code == HTTPDownloader::HTTP_STATUS_CANCELLED ?
RC_API_SERVER_RESPONSE_CLIENT_ERROR :
RC_API_SERVER_RESPONSE_RETRYABLE_CLIENT_ERROR) :
status_code;
rr.body_length = data.size();
rr.body = data.empty() ? nullptr : reinterpret_cast<const char*>(data.data());
callback(&rr, callback_data);
};
HTTPDownloader* http = static_cast<HTTPDownloader*>(rc_client_get_userdata(client));
if (request->post_data)
{
http->CreatePostRequest(request->url, request->post_data, std::move(hd_callback));
}
else
{
http->CreateRequest(request->url, std::move(hd_callback));
}
}
void Achievements::IdleUpdate()
{
if (!IsActive())
return;
const auto lock = GetLock();
s_state.http_downloader->PollRequests();
rc_client_idle(s_state.client);
}
bool Achievements::NeedsIdleUpdate()
{
if (!IsActive())
return false;
const auto lock = GetLock();
return (s_state.http_downloader && s_state.http_downloader->HasAnyRequests());
}
void Achievements::FrameUpdate()
{
if (!IsActive())
return;
auto lock = GetLock();
s_state.http_downloader->PollRequests();
rc_client_do_frame(s_state.client);
UpdateRichPresence(lock);
}
void Achievements::ClientEventHandler(const rc_client_event_t* event, rc_client_t* client)
{
switch (event->type)
{
case RC_CLIENT_EVENT_RESET:
HandleResetEvent(event);
break;
case RC_CLIENT_EVENT_ACHIEVEMENT_TRIGGERED:
HandleUnlockEvent(event);
break;
case RC_CLIENT_EVENT_GAME_COMPLETED:
HandleGameCompleteEvent(event);
break;
case RC_CLIENT_EVENT_SUBSET_COMPLETED:
HandleSubsetCompleteEvent(event);
break;
case RC_CLIENT_EVENT_LEADERBOARD_STARTED:
HandleLeaderboardStartedEvent(event);
break;
case RC_CLIENT_EVENT_LEADERBOARD_FAILED:
HandleLeaderboardFailedEvent(event);
break;
case RC_CLIENT_EVENT_LEADERBOARD_SUBMITTED:
HandleLeaderboardSubmittedEvent(event);
break;
case RC_CLIENT_EVENT_LEADERBOARD_SCOREBOARD:
HandleLeaderboardScoreboardEvent(event);
break;
case RC_CLIENT_EVENT_LEADERBOARD_TRACKER_SHOW:
HandleLeaderboardTrackerShowEvent(event);
break;
case RC_CLIENT_EVENT_LEADERBOARD_TRACKER_HIDE:
HandleLeaderboardTrackerHideEvent(event);
break;
case RC_CLIENT_EVENT_LEADERBOARD_TRACKER_UPDATE:
HandleLeaderboardTrackerUpdateEvent(event);
break;
case RC_CLIENT_EVENT_ACHIEVEMENT_CHALLENGE_INDICATOR_SHOW:
HandleAchievementChallengeIndicatorShowEvent(event);
break;
case RC_CLIENT_EVENT_ACHIEVEMENT_CHALLENGE_INDICATOR_HIDE:
HandleAchievementChallengeIndicatorHideEvent(event);
break;
case RC_CLIENT_EVENT_ACHIEVEMENT_PROGRESS_INDICATOR_SHOW:
HandleAchievementProgressIndicatorShowEvent(event);
break;
case RC_CLIENT_EVENT_ACHIEVEMENT_PROGRESS_INDICATOR_HIDE:
HandleAchievementProgressIndicatorHideEvent(event);
break;
case RC_CLIENT_EVENT_ACHIEVEMENT_PROGRESS_INDICATOR_UPDATE:
HandleAchievementProgressIndicatorUpdateEvent(event);
break;
case RC_CLIENT_EVENT_SERVER_ERROR:
HandleServerErrorEvent(event);
break;
case RC_CLIENT_EVENT_DISCONNECTED:
HandleServerDisconnectedEvent(event);
break;
case RC_CLIENT_EVENT_RECONNECTED:
HandleServerReconnectedEvent(event);
break;
default:
[[unlikely]] ERROR_LOG("Unhandled event: {}", event->type);
break;
}
}
void Achievements::UpdateGameSummary(bool update_progress_database)
{
rc_client_get_user_game_summary(s_state.client, &s_state.game_summary);
if (update_progress_database)
UpdateProgressDatabase();
}
template<typename T>
void Achievements::CachePauseMenuAchievementInfo(const rc_client_achievement_t* achievement, std::optional<T>& value)
{
if (!achievement)
{
value.reset();
return;
}
if (!value.has_value())
value.emplace();
value->title = achievement->title;
value->description = achievement->description;
value->badge_path = GetAchievementBadgePath(achievement, false);
value->measured_percent = achievement->measured_percent;
value->achievement_id = achievement->id;
if constexpr (std::is_base_of_v<PauseMenuMeasuredAchievementInfo, T>)
value->measured_progress = achievement->measured_progress;
if constexpr (std::is_same_v<PauseMenuTimedMeasuredAchievementInfo, T>)
value->show_time = Timer::GetCurrentValue();
}
void Achievements::UpdateRecentUnlockAndAlmostThere()
{
const auto lock = GetLock();
if (!HasActiveGame())
{
s_state.most_recent_unlock.reset();
s_state.achievement_nearest_completion.reset();
return;
}
rc_client_achievement_list_t* const achievements = rc_client_create_achievement_list(
s_state.client, RC_CLIENT_ACHIEVEMENT_CATEGORY_CORE_AND_UNOFFICIAL, RC_CLIENT_ACHIEVEMENT_LIST_GROUPING_PROGRESS);
if (!achievements)
{
s_state.most_recent_unlock.reset();
s_state.achievement_nearest_completion.reset();
return;
}
const rc_client_achievement_t* most_recent_unlock = nullptr;
const rc_client_achievement_t* nearest_completion = nullptr;
for (u32 i = 0; i < achievements->num_buckets; i++)
{
const rc_client_achievement_bucket_t& bucket = achievements->buckets[i];
for (u32 j = 0; j < bucket.num_achievements; j++)
{
const rc_client_achievement_t* achievement = bucket.achievements[j];
if (achievement->state == RC_CLIENT_ACHIEVEMENT_STATE_UNLOCKED)
{
if (!most_recent_unlock || achievement->unlock_time > most_recent_unlock->unlock_time)
most_recent_unlock = achievement;
}
else
{
const float percent_cutoff = 80.0f;
if (achievement->measured_percent >= percent_cutoff &&
(!nearest_completion || achievement->measured_percent > nearest_completion->measured_percent))
{
nearest_completion = achievement;
}
}
}
}
CachePauseMenuAchievementInfo(most_recent_unlock, s_state.most_recent_unlock);
CachePauseMenuAchievementInfo(nearest_completion, s_state.achievement_nearest_completion);
rc_client_destroy_achievement_list(achievements);
}
void Achievements::UpdateRichPresence(std::unique_lock<std::recursive_mutex>& lock)
{
if (!s_state.has_rich_presence)
return;
const Timer::Value now = Timer::GetCurrentValue();
if (Timer::ConvertValueToSeconds(now - s_state.rich_presence_poll_time) < 1)
return;
s_state.rich_presence_poll_time = now;
char buffer[512];
const size_t res = rc_client_get_rich_presence_message(s_state.client, buffer, std::size(buffer));
const std::string_view sv(buffer, res);
if (s_state.rich_presence_string == sv)
return;
s_state.rich_presence_string.assign(sv);
INFO_LOG("Rich presence updated: {}", s_state.rich_presence_string);
Host::OnAchievementsRefreshed();
lock.unlock();
System::UpdateRichPresence(false);
lock.lock();
}
void Achievements::OnSystemStarting(CDImage* image, bool disable_hardcore_mode)
{
std::unique_lock lock(s_state.mutex);
if (!IsActive() || IsRAIntegrationInitializing())
return;
if (!IsLoggedInOrLoggingIn())
{
WARNING_LOG("Not logged in on game booting, trying again.");
TryLoggingInWithToken();
}
if (rc_client_get_hardcore_enabled(s_state.client))
{
WARNING_LOG("Hardcore mode was enabled on system starting.");
OnHardcoreModeChanged(true, false, false);
}
else
{
if (!disable_hardcore_mode && g_settings.achievements_hardcore_mode && IsLoggedInOrLoggingIn())
EnableHardcodeMode(false, false);
}
IdentifyGame(image);
BeginLoadGame();
}
void Achievements::OnSystemDestroyed()
{
ClearGameInfo();
ClearGameHash();
DisableHardcoreMode(false, false);
}
void Achievements::OnSystemReset()
{
const auto lock = GetLock();
if (!IsActive() || IsRAIntegrationInitializing())
return;
if (System::IsValid() && g_settings.achievements_hardcore_mode && !rc_client_get_hardcore_enabled(s_state.client))
{
DEV_LOG("Enabling hardcore mode after reset");
EnableHardcodeMode(true, true);
}
DEV_LOG("Reset client");
rc_client_reset(s_state.client);
}
void Achievements::GameChanged(CDImage* image)
{
std::unique_lock lock(s_state.mutex);
if (!IsActive() || IsRAIntegrationInitializing())
return;
if (!IdentifyGame(image))
return;
if (s_state.load_game_request)
{
rc_client_abort_async(s_state.client, s_state.load_game_request);
s_state.load_game_request = nullptr;
}
s_state.load_game_request =
rc_client_begin_change_media_from_hash(s_state.client, GameHashToString(s_state.game_hash).c_str(),
ClientLoadGameCallback, reinterpret_cast<void*>(static_cast<uintptr_t>(1)));
}
bool Achievements::IdentifyGame(CDImage* image)
{
std::optional<GameHash> game_hash;
if (image)
game_hash = GetGameHash(image);
if (!game_hash.has_value() && !rc_client_is_game_loaded(s_state.client))
{
Host::AddIconOSDWarning(
"AchievementsHashFailed", ICON_EMOJI_WARNING,
TRANSLATE_STR("Achievements", "Failed to read executable from disc. Achievements disabled."),
Host::OSD_ERROR_DURATION);
}
s_state.game_path = image ? image->GetPath() : std::string();
if (s_state.game_hash == game_hash)
{
INFO_LOG("Detected path change to '{}'", s_state.game_path);
return false;
}
s_state.game_hash = game_hash;
return true;
}
bool Achievements::IdentifyCurrentGame()
{
DebugAssert(System::IsValid());
std::unique_ptr<CDImage> temp_image;
if (const std::string& disc_path = System::GetGamePath(); !disc_path.empty())
{
Error error;
temp_image = CDImage::Open(disc_path.c_str(), g_settings.cdrom_load_image_patches, &error);
if (!temp_image)
ERROR_LOG("Failed to open disc for late game identification: {}", error.GetDescription());
}
return IdentifyGame(temp_image.get());
}
void Achievements::BeginLoadGame()
{
if (!s_state.game_hash.has_value())
{
DisableHardcoreMode(false, false);
return;
}
s_state.load_game_request = rc_client_begin_load_game(s_state.client, GameHashToString(s_state.game_hash).c_str(),
ClientLoadGameCallback, nullptr);
}
void Achievements::ClientLoadGameCallback(int result, const char* error_message, rc_client_t* client, void* userdata)
{
const bool was_disc_change = (userdata != nullptr);
s_state.load_game_request = nullptr;
if (result == RC_NO_GAME_LOADED)
{
INFO_LOG("Unknown game '{}', disabling achievements.", GameHashToString(s_state.game_hash));
if (was_disc_change)
ClearGameInfo();
DisableHardcoreMode(false, false);
return;
}
else if (result == RC_LOGIN_REQUIRED)
{
if (!HasSavedCredentials())
{
DisableHardcoreMode(false, false);
return;
}
return;
}
else if (result == RC_HARDCORE_DISABLED)
{
if (error_message)
ReportError(error_message);
OnHardcoreModeChanged(false, true, false);
return;
}
else if (result != RC_OK)
{
ReportFmtError("Loading game failed: {}", error_message);
if (was_disc_change)
ClearGameInfo();
DisableHardcoreMode(false, false);
return;
}
const rc_client_game_t* info = rc_client_get_game_info(s_state.client);
if (!info)
{
ReportError("rc_client_get_game_info() returned NULL");
if (was_disc_change)
ClearGameInfo();
DisableHardcoreMode(false, false);
return;
}
const bool has_achievements = rc_client_has_achievements(client);
const bool has_leaderboards = rc_client_has_leaderboards(client, false);
const bool display_summary = (s_state.game_id != info->id || s_state.game_title != info->title);
if (!has_achievements && !rc_client_has_leaderboards(client, true))
DisableHardcoreMode(false, false);
s_state.game_id = info->id;
s_state.game_title = info->title;
s_state.has_achievements = has_achievements;
s_state.has_leaderboards = has_leaderboards;
s_state.has_rich_presence = rc_client_has_rich_presence(client);
if (display_summary)
GPUThread::RunOnThread(&FullscreenUI::Initialize);
s_state.game_icon_url =
info->badge_url ? std::string(info->badge_url) : GetImageURL(info->badge_name, RC_IMAGE_TYPE_GAME);
s_state.game_icon = GetLocalImagePath(info->badge_name, RC_IMAGE_TYPE_GAME);
if (!s_state.game_icon.empty() && !s_state.game_icon_url.empty() &&
!FileSystem::FileExists(s_state.game_icon.c_str()))
DownloadImage(s_state.game_icon_url, s_state.game_icon);
UpdateGameSummary(true);
if (display_summary)
DisplayAchievementSummary();
Host::OnAchievementsRefreshed();
}
void Achievements::ClearGameInfo()
{
ClearUIState();
if (s_state.load_game_request)
{
rc_client_abort_async(s_state.client, s_state.load_game_request);
s_state.load_game_request = nullptr;
}
rc_client_unload_game(s_state.client);
s_state.active_leaderboard_trackers = {};
s_state.active_challenge_indicators = {};
s_state.active_progress_indicator.reset();
s_state.game_id = 0;
s_state.game_title = {};
s_state.game_icon = {};
s_state.game_icon_url = {};
s_state.has_achievements = false;
s_state.has_leaderboards = false;
s_state.has_rich_presence = false;
s_state.rich_presence_string = {};
s_state.game_summary = {};
Host::OnAchievementsRefreshed();
}
void Achievements::ClearGameHash()
{
s_state.game_path = {};
s_state.game_hash.reset();
}
void Achievements::DisplayAchievementSummary()
{
if (g_settings.achievements_notifications)
{
SmallString summary;
if (s_state.game_summary.num_core_achievements > 0)
{
summary.format(
TRANSLATE_FS("Achievements", "{0}, {1}."),
SmallString::from_format(TRANSLATE_PLURAL_FS("Achievements", "You have unlocked {} of %n achievements",
"Achievement popup", s_state.game_summary.num_core_achievements),
s_state.game_summary.num_unlocked_achievements),
SmallString::from_format(TRANSLATE_PLURAL_FS("Achievements", "and earned {} of %n points", "Achievement popup",
s_state.game_summary.points_core),
s_state.game_summary.points_unlocked));
summary.append('\n');
if (IsHardcoreModeActive())
{
summary.append(
TRANSLATE_SV("Achievements", "Hardcore mode is enabled. Cheats and save states are unavailable."));
}
else
{
summary.append(TRANSLATE_SV("Achievements", "Hardcore mode is disabled. Leaderboards will not be tracked."));
}
}
else
{
summary.assign(TRANSLATE_SV("Achievements", "This game has no achievements."));
}
GPUThread::RunOnThread([title = s_state.game_title, summary = std::string(summary.view()), icon = s_state.game_icon,
time = IsHardcoreModeActive() ? ACHIEVEMENT_SUMMARY_NOTIFICATION_TIME_HC :
ACHIEVEMENT_SUMMARY_NOTIFICATION_TIME]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification("AchievementsSummary", time, std::move(title), std::move(summary),
std::move(icon));
});
if (s_state.game_summary.num_unsupported_achievements > 0)
{
GPUThread::RunOnThread([num_unsupported = s_state.game_summary.num_unsupported_achievements]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification("UnsupportedAchievements", ACHIEVEMENT_SUMMARY_UNSUPPORTED_TIME,
TRANSLATE_STR("Achievements", "Unsupported Achievements"),
TRANSLATE_PLURAL_STR("Achievements",
"%n achievements are not supported by DuckStation.",
"Achievement popup", num_unsupported),
"images/warning.svg");
});
}
}
if (g_settings.achievements_sound_effects)
PlatformMisc::PlaySoundAsync(EmuFolders::GetOverridableResourcePath(INFO_SOUND_NAME).c_str());
}
void Achievements::DisplayHardcoreDeferredMessage()
{
if (g_settings.achievements_hardcore_mode && System::IsValid())
{
GPUThread::RunOnThread([]() {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::ShowToast(std::string(),
TRANSLATE_STR("Achievements", "Hardcore mode will be enabled on system reset."),
Host::OSD_WARNING_DURATION);
});
}
}
void Achievements::HandleResetEvent(const rc_client_event_t* event)
{
WARNING_LOG("Ignoring RC_CLIENT_EVENT_RESET.");
}
void Achievements::HandleUnlockEvent(const rc_client_event_t* event)
{
const rc_client_achievement_t* cheevo = event->achievement;
DebugAssert(cheevo);
INFO_LOG("Achievement {} ({}) for game {} unlocked", cheevo->title, cheevo->id, s_state.game_id);
UpdateGameSummary(true);
if (g_settings.achievements_notifications)
{
std::string title;
if (cheevo->category == RC_CLIENT_ACHIEVEMENT_CATEGORY_UNOFFICIAL)
title = fmt::format(TRANSLATE_FS("Achievements", "{} (Unofficial)"), cheevo->title);
else
title = cheevo->title;
std::string badge_path = GetAchievementBadgePath(cheevo, false);
GPUThread::RunOnThread([id = cheevo->id, duration = g_settings.achievements_notification_duration,
title = std::move(title), description = std::string(cheevo->description),
badge_path = std::move(badge_path)]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification(fmt::format("achievement_unlock_{}", id), static_cast<float>(duration),
std::move(title), std::move(description), std::move(badge_path));
});
}
if (g_settings.achievements_sound_effects)
PlatformMisc::PlaySoundAsync(EmuFolders::GetOverridableResourcePath(UNLOCK_SOUND_NAME).c_str());
}
void Achievements::HandleGameCompleteEvent(const rc_client_event_t* event)
{
INFO_LOG("Game {} complete", s_state.game_id);
UpdateGameSummary(false);
if (g_settings.achievements_notifications)
{
std::string message = fmt::format(
TRANSLATE_FS("Achievements", "Game complete.\n{0}, {1}."),
TRANSLATE_PLURAL_STR("Achievements", "%n achievements", "Mastery popup",
s_state.game_summary.num_unlocked_achievements),
TRANSLATE_PLURAL_STR("Achievements", "%n points", "Achievement points", s_state.game_summary.points_unlocked));
GPUThread::RunOnThread(
[title = s_state.game_title, message = std::move(message), icon = s_state.game_icon]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification("achievement_mastery", GAME_COMPLETE_NOTIFICATION_TIME, std::move(title),
std::move(message), std::move(icon));
});
}
}
void Achievements::HandleSubsetCompleteEvent(const rc_client_event_t* event)
{
INFO_LOG("Subset {} ({}) complete", event->subset->title, event->subset->id);
UpdateGameSummary(false);
if (g_settings.achievements_notifications && event->subset->badge_name[0] != '\0')
{
std::string badge_path = GetLocalImagePath(event->subset->badge_name, RC_IMAGE_TYPE_GAME);
if (!FileSystem::FileExists(badge_path.c_str()))
{
std::string url;
if (IsUsingRAIntegration() || !event->subset->badge_url)
url = GetImageURL(event->subset->badge_name, RC_IMAGE_TYPE_GAME);
else
url = event->subset->badge_url;
DownloadImage(std::move(url), badge_path);
}
std::string title = event->subset->title;
std::string message = fmt::format(
TRANSLATE_FS("Achievements", "Subset complete.\n{0}, {1}."),
TRANSLATE_PLURAL_STR("Achievements", "%n achievements", "Mastery popup",
s_state.game_summary.num_unlocked_achievements),
TRANSLATE_PLURAL_STR("Achievements", "%n points", "Achievement points", s_state.game_summary.points_unlocked));
GPUThread::RunOnThread(
[title = std::move(title), message = std::move(message), badge_path = std::move(badge_path)]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification("achievement_mastery", GAME_COMPLETE_NOTIFICATION_TIME, std::move(title),
std::move(message), std::move(badge_path));
});
}
}
void Achievements::HandleLeaderboardStartedEvent(const rc_client_event_t* event)
{
DEV_LOG("Leaderboard {} ({}) started", event->leaderboard->id, event->leaderboard->title);
if (g_settings.achievements_leaderboard_notifications)
{
std::string title = event->leaderboard->title;
std::string message = TRANSLATE_STR("Achievements", "Leaderboard attempt started.");
GPUThread::RunOnThread([id = event->leaderboard->id, title = std::move(title), message = std::move(message),
icon = s_state.game_icon]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification(fmt::format("leaderboard_{}", id), LEADERBOARD_STARTED_NOTIFICATION_TIME,
std::move(title), std::move(message), std::move(icon));
});
}
}
void Achievements::HandleLeaderboardFailedEvent(const rc_client_event_t* event)
{
DEV_LOG("Leaderboard {} ({}) failed", event->leaderboard->id, event->leaderboard->title);
if (g_settings.achievements_leaderboard_notifications)
{
std::string title = event->leaderboard->title;
std::string message = TRANSLATE_STR("Achievements", "Leaderboard attempt failed.");
GPUThread::RunOnThread([id = event->leaderboard->id, title = std::move(title), message = std::move(message),
icon = s_state.game_icon]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification(fmt::format("leaderboard_{}", id), LEADERBOARD_FAILED_NOTIFICATION_TIME,
std::move(title), std::move(message), std::move(icon));
});
}
}
void Achievements::HandleLeaderboardSubmittedEvent(const rc_client_event_t* event)
{
DEV_LOG("Leaderboard {} ({}) submitted", event->leaderboard->id, event->leaderboard->title);
if (g_settings.achievements_leaderboard_notifications)
{
static const char* value_strings[NUM_RC_CLIENT_LEADERBOARD_FORMATS] = {
TRANSLATE_NOOP("Achievements", "Your Time: {}{}"),
TRANSLATE_NOOP("Achievements", "Your Score: {}{}"),
TRANSLATE_NOOP("Achievements", "Your Value: {}{}"),
};
std::string title = event->leaderboard->title;
std::string message = fmt::format(
fmt::runtime(Host::TranslateToStringView(
"Achievements",
value_strings[std::min<u8>(event->leaderboard->format, NUM_RC_CLIENT_LEADERBOARD_FORMATS - 1)])),
event->leaderboard->tracker_value ? event->leaderboard->tracker_value : "Unknown",
g_settings.achievements_spectator_mode ? std::string_view() : TRANSLATE_SV("Achievements", " (Submitting)"));
GPUThread::RunOnThread([id = event->leaderboard->id, title = std::move(title), message = std::move(message),
icon = s_state.game_icon]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification(fmt::format("leaderboard_{}", id),
static_cast<float>(g_settings.achievements_leaderboard_duration),
std::move(title), std::move(message), std::move(icon));
});
}
if (g_settings.achievements_sound_effects)
PlatformMisc::PlaySoundAsync(EmuFolders::GetOverridableResourcePath(LBSUBMIT_SOUND_NAME).c_str());
}
void Achievements::HandleLeaderboardScoreboardEvent(const rc_client_event_t* event)
{
DEV_LOG("Leaderboard {} scoreboard rank {} of {}", event->leaderboard_scoreboard->leaderboard_id,
event->leaderboard_scoreboard->new_rank, event->leaderboard_scoreboard->num_entries);
if (g_settings.achievements_leaderboard_notifications)
{
static const char* value_strings[NUM_RC_CLIENT_LEADERBOARD_FORMATS] = {
TRANSLATE_NOOP("Achievements", "Your Time: {} (Best: {})"),
TRANSLATE_NOOP("Achievements", "Your Score: {} (Best: {})"),
TRANSLATE_NOOP("Achievements", "Your Value: {} (Best: {})"),
};
std::string title = event->leaderboard->title;
std::string message = fmt::format(
TRANSLATE_FS("Achievements", "{}\nLeaderboard Position: {} of {}"),
fmt::format(fmt::runtime(Host::TranslateToStringView(
"Achievements",
value_strings[std::min<u8>(event->leaderboard->format, NUM_RC_CLIENT_LEADERBOARD_FORMATS - 1)])),
event->leaderboard_scoreboard->submitted_score, event->leaderboard_scoreboard->best_score),
event->leaderboard_scoreboard->new_rank, event->leaderboard_scoreboard->num_entries);
GPUThread::RunOnThread([id = event->leaderboard->id, title = std::move(title), message = std::move(message),
icon = s_state.game_icon]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification(fmt::format("leaderboard_{}", id),
static_cast<float>(g_settings.achievements_leaderboard_duration),
std::move(title), std::move(message), std::move(icon));
});
}
}
void Achievements::HandleLeaderboardTrackerShowEvent(const rc_client_event_t* event)
{
DEV_LOG("Showing leaderboard tracker: {}: {}", event->leaderboard_tracker->id, event->leaderboard_tracker->display);
if (!g_settings.achievements_leaderboard_trackers)
return;
const u32 id = event->leaderboard_tracker->id;
auto it = std::find_if(s_state.active_leaderboard_trackers.begin(), s_state.active_leaderboard_trackers.end(),
[id](const auto& it) { return it.tracker_id == id; });
if (it != s_state.active_leaderboard_trackers.end())
{
WARNING_LOG("Leaderboard tracker {} already active", id);
it->text = event->leaderboard_tracker->display;
it->active = true;
return;
}
s_state.active_leaderboard_trackers.push_back(LeaderboardTrackerIndicator{
.tracker_id = id,
.text = event->leaderboard_tracker->display,
.opacity = 0.0f,
.active = true,
});
}
void Achievements::HandleLeaderboardTrackerHideEvent(const rc_client_event_t* event)
{
const u32 id = event->leaderboard_tracker->id;
DEV_LOG("Hiding leaderboard tracker: {}", id);
auto it = std::find_if(s_state.active_leaderboard_trackers.begin(), s_state.active_leaderboard_trackers.end(),
[id](const auto& it) { return it.tracker_id == id; });
if (it == s_state.active_leaderboard_trackers.end())
return;
it->active = false;
}
void Achievements::HandleLeaderboardTrackerUpdateEvent(const rc_client_event_t* event)
{
const u32 id = event->leaderboard_tracker->id;
DEV_LOG("Updating leaderboard tracker: {}: {}", id, event->leaderboard_tracker->display);
auto it = std::find_if(s_state.active_leaderboard_trackers.begin(), s_state.active_leaderboard_trackers.end(),
[id](const auto& it) { return it.tracker_id == id; });
if (it == s_state.active_leaderboard_trackers.end())
return;
it->text = event->leaderboard_tracker->display;
it->active = true;
}
void Achievements::HandleAchievementChallengeIndicatorShowEvent(const rc_client_event_t* event)
{
if (const auto it =
std::find_if(s_state.active_challenge_indicators.begin(), s_state.active_challenge_indicators.end(),
[event](const AchievementChallengeIndicator& it) { return it.achievement == event->achievement; });
it != s_state.active_challenge_indicators.end())
{
it->active = true;
return;
}
std::string badge_path = GetAchievementBadgePath(event->achievement, false);
if (g_settings.achievements_challenge_indicator_mode == AchievementChallengeIndicatorMode::Notification)
{
std::string title = fmt::format(TRANSLATE_FS("Achievements", "Challenge Started: {}"),
event->achievement->title ? event->achievement->title : "");
GPUThread::RunOnThread(
[title = std::move(title),
description = std::string(event->achievement->description ? event->achievement->description : ""), badge_path,
id = event->achievement->id]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification(fmt::format("AchievementChallenge{}", id), CHALLENGE_STARTED_NOTIFICATION_TIME,
std::move(title), std::move(description), std::move(badge_path));
});
}
s_state.active_challenge_indicators.push_back(
AchievementChallengeIndicator{.achievement = event->achievement,
.badge_path = std::move(badge_path),
.time_remaining = LEADERBOARD_STARTED_NOTIFICATION_TIME,
.opacity = 0.0f,
.active = true});
DEV_LOG("Show challenge indicator for {} ({})", event->achievement->id, event->achievement->title);
}
void Achievements::HandleAchievementChallengeIndicatorHideEvent(const rc_client_event_t* event)
{
auto it =
std::find_if(s_state.active_challenge_indicators.begin(), s_state.active_challenge_indicators.end(),
[event](const AchievementChallengeIndicator& it) { return it.achievement == event->achievement; });
if (it == s_state.active_challenge_indicators.end())
return;
DEV_LOG("Hide challenge indicator for {} ({})", event->achievement->id, event->achievement->title);
if (g_settings.achievements_challenge_indicator_mode == AchievementChallengeIndicatorMode::Notification &&
event->achievement->state == RC_CLIENT_ACHIEVEMENT_STATE_ACTIVE)
{
std::string title = fmt::format(TRANSLATE_FS("Achievements", "Challenge Failed: {}"),
event->achievement->title ? event->achievement->title : "");
std::string badge_path = GetAchievementBadgePath(event->achievement, false);
GPUThread::RunOnThread(
[title = std::move(title),
description = std::string(event->achievement->description ? event->achievement->description : ""),
badge_path = std::move(badge_path), id = event->achievement->id]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification(fmt::format("AchievementChallenge{}", id), CHALLENGE_FAILED_NOTIFICATION_TIME,
std::move(title), std::move(description), std::move(badge_path));
});
}
if (g_settings.achievements_challenge_indicator_mode == AchievementChallengeIndicatorMode::Notification ||
g_settings.achievements_challenge_indicator_mode == AchievementChallengeIndicatorMode::Disabled)
{
s_state.active_challenge_indicators.erase(it);
return;
}
it->active = false;
}
void Achievements::HandleAchievementProgressIndicatorShowEvent(const rc_client_event_t* event)
{
DEV_LOG("Showing progress indicator: {} ({}): {}", event->achievement->id, event->achievement->title,
event->achievement->measured_progress);
if (!g_settings.achievements_progress_indicators)
return;
if (!s_state.active_progress_indicator.has_value())
s_state.active_progress_indicator.emplace();
s_state.active_progress_indicator->achievement = event->achievement;
s_state.active_progress_indicator->badge_path = GetAchievementBadgePath(event->achievement, false);
s_state.active_progress_indicator->opacity = 0.0f;
s_state.active_progress_indicator->active = true;
CachePauseMenuAchievementInfo(event->achievement, s_state.most_recent_progress_update);
}
void Achievements::HandleAchievementProgressIndicatorHideEvent(const rc_client_event_t* event)
{
if (!s_state.active_progress_indicator.has_value())
return;
DEV_LOG("Hiding progress indicator");
if (!g_settings.achievements_progress_indicators)
{
s_state.active_progress_indicator.reset();
return;
}
s_state.active_progress_indicator->active = false;
}
void Achievements::HandleAchievementProgressIndicatorUpdateEvent(const rc_client_event_t* event)
{
DEV_LOG("Updating progress indicator: {} ({}): {}", event->achievement->id, event->achievement->title,
event->achievement->measured_progress);
if (!s_state.active_progress_indicator.has_value())
return;
s_state.active_progress_indicator->achievement = event->achievement;
s_state.active_progress_indicator->active = true;
CachePauseMenuAchievementInfo(event->achievement, s_state.most_recent_progress_update);
}
void Achievements::HandleServerErrorEvent(const rc_client_event_t* event)
{
std::string message =
fmt::format(TRANSLATE_FS("Achievements", "Server error in {}:\n{}"),
event->server_error->api ? event->server_error->api : "UNKNOWN",
event->server_error->error_message ? event->server_error->error_message : "UNKNOWN");
ERROR_LOG(message.c_str());
Host::AddOSDMessage(std::move(message), Host::OSD_ERROR_DURATION);
}
void Achievements::HandleServerDisconnectedEvent(const rc_client_event_t* event)
{
WARNING_LOG("Server disconnected.");
GPUThread::RunOnThread([]() {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::ShowToast(
TRANSLATE_STR("Achievements", "Achievements Disconnected"),
TRANSLATE_STR("Achievements",
"An unlock request could not be completed. We will keep retrying to submit this request."),
Host::OSD_ERROR_DURATION);
});
}
void Achievements::HandleServerReconnectedEvent(const rc_client_event_t* event)
{
WARNING_LOG("Server reconnected.");
GPUThread::RunOnThread([]() {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::ShowToast(TRANSLATE_STR("Achievements", "Achievements Reconnected"),
TRANSLATE_STR("Achievements", "All pending unlock requests have completed."),
Host::OSD_INFO_DURATION);
});
}
void Achievements::EnableHardcodeMode(bool display_message, bool display_game_summary)
{
DebugAssert(IsActive());
if (rc_client_get_hardcore_enabled(s_state.client))
return;
rc_client_set_hardcore_enabled(s_state.client, true);
OnHardcoreModeChanged(true, display_message, display_game_summary);
}
void Achievements::DisableHardcoreMode(bool show_message, bool display_game_summary)
{
if (!IsActive())
return;
const auto lock = GetLock();
if (!rc_client_get_hardcore_enabled(s_state.client))
return;
rc_client_set_hardcore_enabled(s_state.client, false);
OnHardcoreModeChanged(false, show_message, display_game_summary);
}
void Achievements::OnHardcoreModeChanged(bool enabled, bool display_message, bool display_game_summary)
{
INFO_COLOR_LOG(StrongYellow, "Hardcore mode/restrictions are now {}.", enabled ? "ACTIVE" : "inactive");
if (System::IsValid() && display_message)
{
GPUThread::RunOnThread([enabled]() {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::ShowToast(std::string(),
enabled ? TRANSLATE_STR("Achievements", "Hardcore mode is now enabled.") :
TRANSLATE_STR("Achievements", "Hardcore mode is now disabled."),
Host::OSD_INFO_DURATION);
});
}
if (HasActiveGame() && display_game_summary)
{
UpdateGameSummary(true);
DisplayAchievementSummary();
}
DebugAssert((rc_client_get_hardcore_enabled(s_state.client) != 0) == enabled);
if (System::IsValid())
{
Cheats::ReloadCheats(true, true, false, true, true);
Host::RunOnCPUThread([]() { System::ApplySettings(false); });
}
else if (System::GetState() == System::State::Starting)
{
System::ApplySettings(false);
}
ClearUIState();
Host::OnAchievementsHardcoreModeChanged(enabled);
}
bool Achievements::DoState(StateWrapper& sw)
{
static constexpr u32 REQUIRED_VERSION = 56;
if (!IsActive())
{
u32 data_size = 0;
sw.DoEx(&data_size, REQUIRED_VERSION, 0u);
if (data_size > 0)
sw.SkipBytes(data_size);
return !sw.HasError();
}
std::unique_lock lock(s_state.mutex);
if (sw.IsReading())
{
if (s_state.load_game_request)
{
GPUThread::RunOnThread([]() {
FullscreenUI::OpenLoadingScreen(System::GetImageForLoadingScreen(GPUThread::GetGamePath()),
TRANSLATE_SV("Achievements", "Downloading achievements data..."));
});
s_state.http_downloader->WaitForAllRequests();
GPUThread::RunOnThread([]() { FullscreenUI::CloseLoadingScreen(); });
}
u32 data_size = 0;
sw.DoEx(&data_size, REQUIRED_VERSION, 0u);
if (data_size == 0)
{
WARNING_LOG("State is missing cheevos data, resetting runtime");
rc_client_reset(s_state.client);
return !sw.HasError();
}
const std::span<u8> data = sw.GetDeferredBytes(data_size);
if (sw.HasError())
return false;
const int result = rc_client_deserialize_progress_sized(s_state.client, data.data(), data_size);
if (result != RC_OK)
{
WARNING_LOG("Failed to deserialize cheevos state ({}), resetting", result);
rc_client_reset(s_state.client);
}
return true;
}
else
{
const size_t size_pos = sw.GetPosition();
u32 data_size = static_cast<u32>(rc_client_progress_size(s_state.client));
sw.Do(&data_size);
if (data_size > 0)
{
const std::span<u8> data = sw.GetDeferredBytes(data_size);
if (!sw.HasError()) [[likely]]
{
const int result = rc_client_serialize_progress_sized(s_state.client, data.data(), data_size);
if (result != RC_OK)
{
WARNING_LOG("Failed to serialize cheevos state ({})", result);
data_size = 0;
sw.SetPosition(size_pos);
sw.Do(&data_size);
}
}
}
return !sw.HasError();
}
}
std::string Achievements::GetAchievementBadgePath(const rc_client_achievement_t* achievement, bool locked,
bool download_if_missing)
{
const u32 image_type = locked ? RC_IMAGE_TYPE_ACHIEVEMENT_LOCKED : RC_IMAGE_TYPE_ACHIEVEMENT;
const std::string path = GetLocalImagePath(achievement->badge_name, image_type);
if (download_if_missing && !path.empty() && !FileSystem::FileExists(path.c_str()))
{
std::string url;
const char* url_ptr;
if (IsUsingRAIntegration() || !(url_ptr = locked ? achievement->badge_locked_url : achievement->badge_url))
url = GetImageURL(achievement->badge_name, image_type);
else
url = std::string(url_ptr);
if (url.empty()) [[unlikely]]
ReportFmtError("Acheivement {} with badge name {} has no badge URL", achievement->id, achievement->badge_name);
else
DownloadImage(std::string(url), path);
}
return path;
}
const std::string& Achievements::GetCachedAchievementBadgePath(const rc_client_achievement_t* achievement, bool locked)
{
for (const auto& [l_cheevo, l_path, l_state] : s_state.achievement_badge_paths)
{
if (l_cheevo == achievement && l_state == locked)
return l_path;
}
std::string path = GetAchievementBadgePath(achievement, locked);
return std::get<1>(s_state.achievement_badge_paths.emplace_back(achievement, std::move(path), locked));
}
std::string Achievements::GetLeaderboardUserBadgePath(const rc_client_leaderboard_entry_t* entry)
{
const std::string path = GetLocalImagePath(entry->user, RC_IMAGE_TYPE_USER);
if (!FileSystem::FileExists(path.c_str()))
{
std::string url = GetImageURL(entry->user, RC_IMAGE_TYPE_USER);
if (!url.empty())
DownloadImage(std::move(url), path);
}
return path;
}
bool Achievements::IsLoggedIn()
{
return (rc_client_get_user_info(s_state.client) != nullptr);
}
bool Achievements::IsLoggedInOrLoggingIn()
{
return (IsLoggedIn() || s_state.login_request);
}
bool Achievements::Login(const char* username, const char* password, Error* error)
{
auto lock = GetLock();
rc_client_t* client = s_state.client;
HTTPDownloader* http = s_state.http_downloader.get();
const bool is_temporary_client = (client == nullptr);
std::unique_ptr<HTTPDownloader> temporary_downloader;
ScopedGuard temporary_client_guard = [&client, is_temporary_client, &temporary_downloader]() {
if (is_temporary_client)
DestroyClient(&client, &temporary_downloader);
};
if (is_temporary_client)
{
if (!CreateClient(&client, &temporary_downloader))
{
Error::SetString(error, "Failed to create client.");
return false;
}
http = temporary_downloader.get();
}
LoginWithPasswordParameters params = {username, error, nullptr, false};
params.request =
rc_client_begin_login_with_password(client, username, password, ClientLoginWithPasswordCallback, ¶ms);
if (!params.request)
{
Error::SetString(error, "Failed to create login request.");
return false;
}
http->WaitForAllRequestsWithYield([&lock]() { lock.unlock(); }, [&lock]() { lock.lock(); });
Assert(!params.request);
if (!params.result)
return false;
if (System::IsValid() && !is_temporary_client)
{
IdentifyCurrentGame();
BeginLoadGame();
}
return true;
}
void Achievements::ClientLoginWithPasswordCallback(int result, const char* error_message, rc_client_t* client,
void* userdata)
{
Assert(userdata);
LoginWithPasswordParameters* params = static_cast<LoginWithPasswordParameters*>(userdata);
params->request = nullptr;
if (result != RC_OK)
{
ERROR_LOG("Login failed: {}: {}", rc_error_str(result), error_message ? error_message : "Unknown");
Error::SetString(params->error,
fmt::format("{}: {}", rc_error_str(result), error_message ? error_message : "Unknown"));
params->result = false;
return;
}
const rc_client_user_t* user = rc_client_get_user_info(client);
if (!user || !user->token)
{
ERROR_LOG("rc_client_get_user_info() returned NULL");
Error::SetString(params->error, "rc_client_get_user_info() returned NULL");
params->result = false;
return;
}
params->result = true;
Host::SetBaseStringSettingValue("Cheevos", "Username", params->username);
Host::SetBaseStringSettingValue("Cheevos", "Token", EncryptLoginToken(user->token, params->username));
Host::SetBaseStringSettingValue("Cheevos", "LoginTimestamp", fmt::format("{}", std::time(nullptr)).c_str());
Host::CommitBaseSettingChanges();
FinishLogin(client);
}
void Achievements::ClientLoginWithTokenCallback(int result, const char* error_message, rc_client_t* client,
void* userdata)
{
s_state.login_request = nullptr;
if (result == RC_INVALID_CREDENTIALS || result == RC_EXPIRED_TOKEN)
{
ERROR_LOG("Login failed due to invalid token: {}: {}", rc_error_str(result), error_message);
Host::OnAchievementsLoginRequested(LoginRequestReason::TokenInvalid);
return;
}
else if (result != RC_OK)
{
ERROR_LOG("Login failed: {}: {}", rc_error_str(result), error_message);
if (System::IsValid())
{
std::string message = fmt::format(
TRANSLATE_FS("Achievements", "Achievement unlocks will not be submitted for this session.\nError: {}"),
error_message);
GPUThread::RunOnThread([message = std::move(message)]() mutable {
if (!GPUThread::HasGPUBackend() || !FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification("AchievementsLoginFailed", Host::OSD_ERROR_DURATION,
TRANSLATE_STR("Achievements", "RetroAchievements Login Failed"),
std::move(message), "images/warning.svg");
});
}
return;
}
FinishLogin(client);
}
void Achievements::FinishLogin(const rc_client_t* client)
{
const rc_client_user_t* user = rc_client_get_user_info(client);
if (!user)
return;
PreloadHashDatabase();
Host::OnAchievementsLoginSuccess(user->username, user->score, user->score_softcore, user->num_unread_messages);
if (System::IsValid())
{
const auto lock = GetLock();
if (s_state.client == client)
Host::RunOnCPUThread(ShowLoginNotification);
}
}
void Achievements::ShowLoginNotification()
{
const rc_client_user_t* user = rc_client_get_user_info(s_state.client);
if (!user)
return;
if (g_settings.achievements_notifications)
{
std::string badge_path = GetLoggedInUserBadgePath();
std::string title = user->display_name;
std::string summary = fmt::format(TRANSLATE_FS("Achievements", "Score: {} ({} softcore)\nUnread messages: {}"),
user->score, user->score_softcore, user->num_unread_messages);
GPUThread::RunOnThread(
[title = std::move(title), summary = std::move(summary), badge_path = std::move(badge_path)]() mutable {
if (!FullscreenUI::Initialize())
return;
ImGuiFullscreen::AddNotification("achievements_login", LOGIN_NOTIFICATION_TIME, std::move(title),
std::move(summary), std::move(badge_path));
});
}
}
const char* Achievements::GetLoggedInUserName()
{
const rc_client_user_t* user = rc_client_get_user_info(s_state.client);
if (!user) [[unlikely]]
return nullptr;
return user->username;
}
std::string Achievements::GetLoggedInUserBadgePath()
{
std::string badge_path;
const rc_client_user_t* user = rc_client_get_user_info(s_state.client);
if (!user) [[unlikely]]
return badge_path;
badge_path = GetLocalImagePath(user->username, RC_IMAGE_TYPE_USER);
if (!badge_path.empty() && !FileSystem::FileExists(badge_path.c_str())) [[unlikely]]
{
std::string url;
if (IsUsingRAIntegration() || !user->avatar_url)
url = GetImageURL(user->username, RC_IMAGE_TYPE_USER);
else
url = user->avatar_url;
DownloadImage(std::move(url), badge_path);
}
return badge_path;
}
SmallString Achievements::GetLoggedInUserPointsSummary()
{
SmallString ret;
const rc_client_user_t* user = rc_client_get_user_info(s_state.client);
if (!user) [[unlikely]]
return ret;
ret.format(TRANSLATE_FS("Achievements", "Score: {} ({} softcore)"), user->score, user->score_softcore);
return ret;
}
u32 Achievements::GetPauseThrottleFrames()
{
if (!IsActive() || !IsHardcoreModeActive())
return 0;
u32 frames_remaining = 0;
return rc_client_can_pause(s_state.client, &frames_remaining) ? 0 : frames_remaining;
}
void Achievements::Logout()
{
if (IsActive())
{
const auto lock = GetLock();
if (HasActiveGame())
{
ClearGameInfo();
DisableHardcoreMode(false, false);
}
CancelHashDatabaseRequests();
INFO_LOG("Logging out...");
rc_client_logout(s_state.client);
}
INFO_LOG("Clearing credentials...");
Host::DeleteBaseSettingValue("Cheevos", "Username");
Host::DeleteBaseSettingValue("Cheevos", "Token");
Host::DeleteBaseSettingValue("Cheevos", "LoginTimestamp");
Host::CommitBaseSettingChanges();
ClearProgressDatabase();
}
bool Achievements::ConfirmHardcoreModeDisable(const char* trigger)
{
const bool confirmed = Host::ConfirmMessage(
TRANSLATE("Achievements", "Confirm Hardcore Mode Disable"),
fmt::format(TRANSLATE_FS("Achievements", "{0} cannot be performed while hardcore mode is active. Do you "
"want to disable hardcore mode? {0} will be cancelled if you select No."),
trigger));
if (!confirmed)
return false;
DisableHardcoreMode(true, true);
return true;
}
void Achievements::ConfirmHardcoreModeDisableAsync(const char* trigger, std::function<void(bool)> callback)
{
Host::ConfirmMessageAsync(
TRANSLATE_STR("Achievements", "Confirm Hardcore Mode Disable"),
fmt::format(TRANSLATE_FS("Achievements", "{0} cannot be performed while hardcore mode is active. Do you want to "
"disable hardcore mode? {0} will be cancelled if you select No."),
trigger),
[callback = std::move(callback)](bool res) mutable {
Host::RunOnCPUThread([callback = std::move(callback), res]() {
if (res)
DisableHardcoreMode(true, true);
callback(res);
});
});
}
void Achievements::ClearUIState()
{
if (!FullscreenUI::IsInitialized())
return;
CloseLeaderboard();
s_state.achievement_badge_paths = {};
s_state.leaderboard_user_icon_paths = {};
s_state.leaderboard_entry_lists = {};
if (s_state.leaderboard_list)
{
rc_client_destroy_leaderboard_list(s_state.leaderboard_list);
s_state.leaderboard_list = nullptr;
}
if (s_state.achievement_list)
{
rc_client_destroy_achievement_list(s_state.achievement_list);
s_state.achievement_list = nullptr;
}
s_state.most_recent_unlock.reset();
s_state.achievement_nearest_completion.reset();
}
static float IndicatorOpacity(float delta_time, bool active, float& opacity)
{
float target, rate;
if (active)
{
target = 1.0f;
rate = Achievements::INDICATOR_FADE_IN_TIME;
}
else
{
target = 0.0f;
rate = -Achievements::INDICATOR_FADE_OUT_TIME;
}
if (opacity != target)
opacity = ImSaturate(opacity + (delta_time / rate));
return opacity;
}
void Achievements::DrawGameOverlays()
{
using ImGuiFullscreen::LayoutScale;
using ImGuiFullscreen::ModAlpha;
using ImGuiFullscreen::RenderShadowedTextClipped;
using ImGuiFullscreen::UIStyle;
if (!HasActiveGame())
return;
const auto lock = GetLock();
constexpr float bg_opacity = 0.8f;
const float margin =
std::max(ImCeil(ImGuiManager::GetScreenMargin() * ImGuiManager::GetGlobalScale()), LayoutScale(10.0f));
const float spacing = LayoutScale(10.0f);
const float padding = LayoutScale(10.0f);
const float rounding = LayoutScale(10.0f);
const ImVec2 image_size = LayoutScale(50.0f, 50.0f);
const ImGuiIO& io = ImGui::GetIO();
ImVec2 position = ImVec2(io.DisplaySize.x - margin, io.DisplaySize.y - margin);
ImDrawList* dl = ImGui::GetBackgroundDrawList();
if (!s_state.active_challenge_indicators.empty() &&
(g_settings.achievements_challenge_indicator_mode == AchievementChallengeIndicatorMode::PersistentIcon ||
g_settings.achievements_challenge_indicator_mode == AchievementChallengeIndicatorMode::TemporaryIcon))
{
const bool use_time_remaining =
(g_settings.achievements_challenge_indicator_mode == AchievementChallengeIndicatorMode::TemporaryIcon);
const float x_advance = image_size.x + spacing;
ImVec2 current_position = ImVec2(position.x - image_size.x, position.y - image_size.y);
for (auto it = s_state.active_challenge_indicators.begin(); it != s_state.active_challenge_indicators.end();)
{
AchievementChallengeIndicator& indicator = *it;
bool active = indicator.active;
if (use_time_remaining)
{
indicator.time_remaining = std::max(indicator.time_remaining - io.DeltaTime, 0.0f);
active = (indicator.time_remaining > 0.0f);
}
const float opacity = IndicatorOpacity(io.DeltaTime, active, indicator.opacity);
GPUTexture* badge = ImGuiFullscreen::GetCachedTextureAsync(indicator.badge_path);
if (badge)
{
dl->AddImage(badge, current_position, current_position + image_size, ImVec2(0.0f, 0.0f), ImVec2(1.0f, 1.0f),
ImGui::GetColorU32(ImVec4(1.0f, 1.0f, 1.0f, opacity)));
current_position.x -= x_advance;
}
if (!indicator.active && opacity <= 0.01f)
{
DEV_LOG("Remove challenge indicator");
it = s_state.active_challenge_indicators.erase(it);
}
else
{
++it;
}
}
position.y -= image_size.y + padding;
}
if (s_state.active_progress_indicator.has_value())
{
AchievementProgressIndicator& indicator = s_state.active_progress_indicator.value();
const float opacity = IndicatorOpacity(io.DeltaTime, indicator.active, indicator.opacity);
const std::string_view text = s_state.active_progress_indicator->achievement->measured_progress;
const ImVec2 text_size = UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.NormalFontWeight, FLT_MAX,
0.0f, IMSTR_START_END(text));
const ImVec2 box_min = ImVec2(position.x - image_size.x - text_size.x - spacing - padding * 2.0f,
position.y - image_size.y - padding * 2.0f);
const ImVec2 box_max = position;
dl->AddRectFilled(box_min, box_max,
ImGui::GetColorU32(ModAlpha(UIStyle.ToastBackgroundColor, opacity * bg_opacity)), rounding);
GPUTexture* badge = ImGuiFullscreen::GetCachedTextureAsync(indicator.badge_path);
if (badge)
{
const ImVec2 badge_pos = box_min + ImVec2(padding, padding);
dl->AddImage(badge, badge_pos, badge_pos + image_size, ImVec2(0.0f, 0.0f), ImVec2(1.0f, 1.0f),
ImGui::GetColorU32(ImVec4(1.0f, 1.0f, 1.0f, opacity)));
}
const ImVec2 text_pos =
box_min + ImVec2(padding + image_size.x + spacing, (box_max.y - box_min.y - text_size.y) * 0.5f);
const ImRect text_clip_rect(text_pos, box_max);
RenderShadowedTextClipped(dl, UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, text_pos, box_max,
ImGui::GetColorU32(ModAlpha(UIStyle.ToastTextColor, opacity)), text, &text_size,
ImVec2(0.0f, 0.0f), 0.0f, &text_clip_rect);
if (!indicator.active && opacity <= 0.01f)
{
DEV_LOG("Remove progress indicator");
s_state.active_progress_indicator.reset();
}
position.y -= image_size.y + padding * 3.0f;
}
if (!s_state.active_leaderboard_trackers.empty())
{
for (auto it = s_state.active_leaderboard_trackers.begin(); it != s_state.active_leaderboard_trackers.end();)
{
LeaderboardTrackerIndicator& indicator = *it;
const float opacity = IndicatorOpacity(io.DeltaTime, indicator.active, indicator.opacity);
TinyString width_string;
width_string.append(ICON_FA_STOPWATCH);
for (u32 i = 0; i < indicator.text.length(); i++)
width_string.append('0');
const ImVec2 size = UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.NormalFontWeight, FLT_MAX, 0.0f,
IMSTR_START_END(width_string));
const ImRect box(ImVec2(position.x - size.x - padding * 2.0f, position.y - size.y - padding * 2.0f), position);
dl->AddRectFilled(box.Min, box.Max,
ImGui::GetColorU32(ModAlpha(UIStyle.ToastBackgroundColor, opacity * bg_opacity)), rounding);
const u32 text_col = ImGui::GetColorU32(ModAlpha(UIStyle.ToastTextColor, opacity));
const ImVec2 text_size = UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.NormalFontWeight, FLT_MAX,
0.0f, IMSTR_START_END(indicator.text));
const ImVec2 text_pos = ImVec2(box.Max.x - padding - text_size.x, box.Min.y + padding);
RenderShadowedTextClipped(dl, UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, text_pos, box.Max,
text_col, indicator.text, &text_size, ImVec2(0.0f, 0.0f), 0.0f, &box);
const ImVec2 icon_pos = ImVec2(box.Min.x + padding, box.Min.y + padding);
RenderShadowedTextClipped(dl, UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, icon_pos, box.Max,
text_col, ICON_FA_STOPWATCH, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &box);
if (!indicator.active && opacity <= 0.01f)
{
DEV_LOG("Remove tracker indicator");
it = s_state.active_leaderboard_trackers.erase(it);
}
else
{
++it;
}
position.x = box.Min.x - padding;
}
}
}
#ifndef __ANDROID__
void Achievements::DrawPauseMenuOverlays(float start_pos_y)
{
using ImGuiFullscreen::DarkerColor;
using ImGuiFullscreen::LayoutScale;
using ImGuiFullscreen::ModAlpha;
using ImGuiFullscreen::UIStyle;
if (!HasActiveGame() || !HasAchievements())
return;
const auto lock = GetLock();
const ImVec2& display_size = ImGui::GetIO().DisplaySize;
const float box_margin = LayoutScale(10.0f);
const float box_width = LayoutScale(450.0f);
const float box_padding = LayoutScale(15.0f);
const float box_content_width = box_width - box_padding - box_padding;
const float box_rounding = LayoutScale(20.0f);
const u32 box_background_color = ImGui::GetColorU32(ModAlpha(UIStyle.BackgroundColor, 0.8f));
const ImU32 box_title_text_color =
ImGui::GetColorU32(DarkerColor(UIStyle.BackgroundTextColor, 0.9f)) | IM_COL32_A_MASK;
const ImU32 title_text_color = ImGui::GetColorU32(UIStyle.BackgroundTextColor) | IM_COL32_A_MASK;
const ImU32 text_color =
ImGui::GetColorU32(DarkerColor(DarkerColor(UIStyle.BackgroundTextColor, 0.9f))) | IM_COL32_A_MASK;
const float paragraph_spacing = LayoutScale(10.0f);
const float text_spacing = LayoutScale(2.0f);
const float progress_height = LayoutScale(20.0f);
const float progress_rounding = LayoutScale(5.0f);
const float badge_size = LayoutScale(32.0f);
const float badge_text_width = box_content_width - badge_size - (text_spacing * 3.0f);
const bool disconnected = rc_client_is_disconnected(s_state.client);
const int pending_count = disconnected ? rc_client_get_award_achievement_pending_count(s_state.client) : 0;
ImDrawList* dl = ImGui::GetBackgroundDrawList();
float box_height = box_padding + box_padding + UIStyle.MediumFontSize + paragraph_spacing + progress_height +
((pending_count > 0) ? (paragraph_spacing + UIStyle.MediumFontSize) : 0.0f);
ImVec2 box_min = ImVec2(display_size.x - box_width - box_margin, start_pos_y + box_margin);
ImVec2 box_max = ImVec2(box_min.x + box_width, box_min.y + box_height);
ImVec2 text_pos = ImVec2(box_min.x + box_padding, box_min.y + box_padding);
ImVec2 text_size;
TinyString buffer;
dl->AddRectFilled(box_min, box_max, box_background_color, box_rounding);
{
buffer.format(ICON_EMOJI_UNLOCKED " {}",
TRANSLATE_DISAMBIG_SV("Achievements", "Achievements Unlocked", "Pause Menu"));
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, text_pos, box_title_text_color,
IMSTR_START_END(buffer));
const float unlocked_fraction = static_cast<float>(s_state.game_summary.num_unlocked_achievements) /
static_cast<float>(s_state.game_summary.num_core_achievements);
buffer.format("{}%", static_cast<u32>(std::round(unlocked_fraction * 100.0f)));
text_size = UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.BoldFontWeight, FLT_MAX, 0.0f,
IMSTR_START_END(buffer));
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight,
ImVec2(text_pos.x + (box_content_width - text_size.x), text_pos.y), text_color,
IMSTR_START_END(buffer));
text_pos.y += UIStyle.MediumFontSize + paragraph_spacing;
const ImRect progress_bb(text_pos, text_pos + ImVec2(box_content_width, progress_height));
dl->AddRectFilled(progress_bb.Min, progress_bb.Max, ImGui::GetColorU32(UIStyle.PrimaryDarkColor),
progress_rounding);
if (s_state.game_summary.num_unlocked_achievements > 0)
{
ImGui::RenderRectFilledRangeH(dl, progress_bb, ImGui::GetColorU32(DarkerColor(UIStyle.SecondaryColor)), 0.0f,
unlocked_fraction, progress_rounding);
}
buffer.format("{}/{}", s_state.game_summary.num_unlocked_achievements, s_state.game_summary.num_core_achievements);
text_size = UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.BoldFontWeight, FLT_MAX, 0.0f,
IMSTR_START_END(buffer));
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight,
ImVec2(progress_bb.Min.x + ((progress_bb.Max.x - progress_bb.Min.x) / 2.0f) - (text_size.x / 2.0f),
progress_bb.Min.y + ((progress_bb.Max.y - progress_bb.Min.y) / 2.0f) - (text_size.y / 2.0f)),
ImGui::GetColorU32(UIStyle.PrimaryTextColor), IMSTR_START_END(buffer));
text_pos.y += progress_height;
if (pending_count > 0)
{
text_pos.y += paragraph_spacing;
buffer.format(ICON_EMOJI_WARNING " {}",
TRANSLATE_PLURAL_SSTR("Achievements", "%n unlocks have not been confirmed by the server.",
"Pause Menu", pending_count));
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, text_pos, title_text_color,
IMSTR_START_END(buffer));
text_pos.y += UIStyle.MediumFontSize;
}
}
const auto draw_achievement_in_box =
[&box_margin, &box_width, &box_padding, &box_rounding, &box_content_width, &box_background_color, &box_min,
&box_max, &badge_text_width, &dl, &box_title_text_color, &title_text_color, &text_color, ¶graph_spacing,
&text_spacing, &progress_rounding, &text_pos,
&badge_size](std::string_view box_title, std::string_view title, std::string_view description,
const std::string& badge_path, std::string_view measured_progress, float measured_percent) {
const ImVec2 description_size =
description.empty() ? ImVec2(0.0f, 0.0f) :
UIStyle.Font->CalcTextSizeA(UIStyle.MediumSmallFontSize, UIStyle.NormalFontWeight,
FLT_MAX, badge_text_width, IMSTR_START_END(description));
const float box_height = box_padding + box_padding + UIStyle.MediumFontSize + paragraph_spacing +
std::max((title.empty() ? 0.0f : UIStyle.MediumSmallFontSize) +
(description.empty() ? 0.0f : (text_spacing + description_size.y)),
badge_size);
box_min = ImVec2(box_min.x, box_max.y + box_margin);
box_max = ImVec2(box_min.x + box_width, box_min.y + box_height);
text_pos = ImVec2(box_min.x + box_padding, box_min.y + box_padding);
dl->AddRectFilled(box_min, box_max, box_background_color, box_rounding);
ImVec4 clip_rect = ImVec4(text_pos.x, text_pos.y, text_pos.x + box_content_width, box_max.y);
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, text_pos, box_title_text_color,
IMSTR_START_END(box_title), 0.0f, &clip_rect);
if (!measured_progress.empty())
{
const float progress_width = LayoutScale(100.0f);
const float progress_height = UIStyle.MediumFontSize;
const ImRect progress_bb(ImVec2(text_pos.x + box_content_width - progress_width, text_pos.y),
ImVec2(text_pos.x + box_content_width, text_pos.y + progress_height));
dl->AddRectFilled(progress_bb.Min, progress_bb.Max, ImGui::GetColorU32(UIStyle.PrimaryDarkColor),
progress_rounding);
if (measured_percent > 0.0f)
{
ImGui::RenderRectFilledRangeH(dl, progress_bb, ImGui::GetColorU32(DarkerColor(UIStyle.SecondaryColor)), 0.0f,
measured_percent * 0.01f, progress_rounding);
}
const ImVec2 measured_progress_size =
UIStyle.Font->CalcTextSizeA(UIStyle.MediumSmallFontSize, UIStyle.BoldFontWeight, FLT_MAX, badge_text_width,
IMSTR_START_END(measured_progress));
dl->AddText(
UIStyle.Font, UIStyle.MediumSmallFontSize, UIStyle.BoldFontWeight,
ImVec2(
progress_bb.Min.x + ((progress_bb.Max.x - progress_bb.Min.x) / 2.0f) - (measured_progress_size.x / 2.0f),
progress_bb.Min.y + ((progress_bb.Max.y - progress_bb.Min.y) / 2.0f) - (measured_progress_size.y / 2.0f)),
ImGui::GetColorU32(UIStyle.PrimaryTextColor), IMSTR_START_END(measured_progress));
}
text_pos.y += UIStyle.MediumFontSize + paragraph_spacing;
const ImVec2 image_max = ImVec2(text_pos.x + badge_size, text_pos.y + badge_size);
ImVec2 badge_text_pos = ImVec2(image_max.x + (text_spacing * 3.0f), text_pos.y);
clip_rect = ImVec4(badge_text_pos.x, badge_text_pos.y, badge_text_pos.x + badge_text_width, box_max.y);
GPUTexture* badge_tex = ImGuiFullscreen::GetCachedTextureAsync(badge_path);
dl->AddImage(badge_tex, text_pos, image_max);
if (!title.empty())
{
dl->AddText(UIStyle.Font, UIStyle.MediumSmallFontSize, UIStyle.BoldFontWeight, badge_text_pos, title_text_color,
IMSTR_START_END(title), 0.0f, &clip_rect);
badge_text_pos.y += UIStyle.MediumSmallFontSize;
}
if (!description.empty())
{
badge_text_pos.y += text_spacing;
dl->AddText(UIStyle.Font, UIStyle.MediumSmallFontSize, UIStyle.NormalFontWeight, badge_text_pos, text_color,
IMSTR_START_END(description), badge_text_width, &clip_rect);
badge_text_pos.y += description_size.y;
}
};
const auto get_achievement_height = [&badge_size, &badge_text_width, &text_spacing](std::string_view description) {
const ImVec2 description_size =
description.empty() ? ImVec2(0.0f, 0.0f) :
UIStyle.Font->CalcTextSizeA(UIStyle.MediumSmallFontSize, UIStyle.NormalFontWeight, FLT_MAX,
badge_text_width, IMSTR_START_END(description));
const float text_height = UIStyle.MediumSmallFontSize + text_spacing + description_size.y;
return std::max(text_height, badge_size);
};
const auto draw_achievement_with_summary = [&box_max, &badge_text_width, &dl, &title_text_color, &text_color,
&text_spacing, &text_pos,
&badge_size](std::string_view title, std::string_view description,
const std::string& badge_path) {
const ImVec2 image_max = ImVec2(text_pos.x + badge_size, text_pos.y + badge_size);
ImVec2 badge_text_pos = ImVec2(image_max.x + (text_spacing * 3.0f), text_pos.y);
const ImVec4 clip_rect = ImVec4(badge_text_pos.x, badge_text_pos.y, badge_text_pos.x + badge_text_width, box_max.y);
ImVec2 text_size = description.empty() ?
ImVec2(0.0f, 0.0f) :
UIStyle.Font->CalcTextSizeA(UIStyle.MediumSmallFontSize, UIStyle.NormalFontWeight, FLT_MAX,
badge_text_width, IMSTR_START_END(description));
GPUTexture* badge_tex = ImGuiFullscreen::GetCachedTextureAsync(badge_path);
dl->AddImage(badge_tex, text_pos, image_max);
if (!title.empty())
{
dl->AddText(UIStyle.Font, UIStyle.MediumSmallFontSize, UIStyle.BoldFontWeight, badge_text_pos, title_text_color,
IMSTR_START_END(title), 0.0f, &clip_rect);
badge_text_pos.y += UIStyle.MediumSmallFontSize + text_spacing;
}
if (!description.empty())
{
dl->AddText(UIStyle.Font, UIStyle.MediumSmallFontSize, UIStyle.NormalFontWeight, badge_text_pos, text_color,
IMSTR_START_END(description), badge_text_width, &clip_rect);
badge_text_pos.y += text_size.y;
}
text_pos.y = badge_text_pos.y;
};
if (s_state.most_recent_unlock.has_value())
{
buffer.format(ICON_FA_LOCK_OPEN " {}", TRANSLATE_DISAMBIG_SV("Achievements", "Most Recent", "Pause Menu"));
draw_achievement_in_box(buffer, s_state.most_recent_unlock->title, s_state.most_recent_unlock->description,
s_state.most_recent_unlock->badge_path, {}, 0.0f);
text_pos.y += s_state.achievement_nearest_completion ? (paragraph_spacing + paragraph_spacing) : 0.0f;
}
if (s_state.achievement_nearest_completion.has_value() &&
(!s_state.most_recent_progress_update ||
s_state.most_recent_progress_update->achievement_id != s_state.achievement_nearest_completion->achievement_id))
{
buffer.format(ICON_FA_GAUGE_HIGH " {}", TRANSLATE_DISAMBIG_SV("Achievements", "Nearest Completion", "Pause Menu"));
draw_achievement_in_box(
buffer, s_state.achievement_nearest_completion->title, s_state.achievement_nearest_completion->description,
s_state.achievement_nearest_completion->badge_path, s_state.achievement_nearest_completion->measured_progress,
s_state.achievement_nearest_completion->measured_percent);
text_pos.y += paragraph_spacing;
}
if (s_state.most_recent_progress_update.has_value())
{
if (Timer::ConvertValueToSeconds(Timer::GetCurrentValue() - s_state.most_recent_progress_update->show_time) <
PAUSE_MENU_PROGRESS_DISPLAY_TIME)
{
buffer.format(ICON_FA_RULER_HORIZONTAL " {}",
TRANSLATE_DISAMBIG_SV("Achievements", "Last Progress Update", "Pause Menu"));
draw_achievement_in_box(
buffer, s_state.most_recent_progress_update->title, s_state.most_recent_progress_update->description,
s_state.most_recent_progress_update->badge_path, s_state.most_recent_progress_update->measured_progress,
s_state.most_recent_progress_update->measured_percent);
text_pos.y += paragraph_spacing;
}
else
{
s_state.most_recent_progress_update.reset();
}
}
if (!s_state.active_challenge_indicators.empty())
{
box_height = box_padding + box_padding + UIStyle.MediumFontSize;
for (size_t i = 0; i < s_state.active_challenge_indicators.size(); i++)
{
const AchievementChallengeIndicator& indicator = s_state.active_challenge_indicators[i];
box_height += paragraph_spacing + get_achievement_height(indicator.achievement->description) +
((i == (s_state.active_challenge_indicators.size() - 1)) ? 0.0f : paragraph_spacing);
}
box_min = ImVec2(box_min.x, box_max.y + box_margin);
box_max = ImVec2(box_min.x + box_width, box_min.y + box_height);
text_pos = ImVec2(box_min.x + box_padding, box_min.y + box_padding);
dl->AddRectFilled(box_min, box_max, box_background_color, box_rounding);
buffer.format(ICON_FA_STOPWATCH " {}",
TRANSLATE_DISAMBIG_SV("Achievements", "Active Challenge Achievements", "Pause Menu"));
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, text_pos, box_title_text_color,
IMSTR_START_END(buffer));
text_pos.y += UIStyle.MediumFontSize;
for (const AchievementChallengeIndicator& indicator : s_state.active_challenge_indicators)
{
text_pos.y += paragraph_spacing;
draw_achievement_with_summary(indicator.achievement->title, indicator.achievement->description,
indicator.badge_path);
text_pos.y += paragraph_spacing;
}
}
}
bool Achievements::PrepareAchievementsWindow()
{
auto lock = Achievements::GetLock();
s_state.achievement_badge_paths = {};
if (s_state.achievement_list)
rc_client_destroy_achievement_list(s_state.achievement_list);
s_state.achievement_list = rc_client_create_achievement_list(
s_state.client, RC_CLIENT_ACHIEVEMENT_CATEGORY_CORE_AND_UNOFFICIAL,
RC_CLIENT_ACHIEVEMENT_LIST_GROUPING_PROGRESS );
if (!s_state.achievement_list)
{
ERROR_LOG("rc_client_create_achievement_list() returned null");
return false;
}
for (size_t i = 0; i < s_state.achievement_list->num_buckets; i++)
{
const rc_client_achievement_bucket_t* bucket = &s_state.achievement_list->buckets[i];
if (bucket->bucket_type == RC_CLIENT_ACHIEVEMENT_BUCKET_UNLOCKED)
{
std::sort(bucket->achievements, bucket->achievements + bucket->num_achievements,
[](const rc_client_achievement_t* a, const rc_client_achievement_t* b) {
return a->unlock_time > b->unlock_time;
});
}
}
return true;
}
void Achievements::DrawAchievementsWindow()
{
using ImGuiFullscreen::LayoutScale;
using ImGuiFullscreen::RenderShadowedTextClipped;
using ImGuiFullscreen::UIStyle;
const auto lock = Achievements::GetLock();
if (!s_state.achievement_list)
{
FullscreenUI::ReturnToPreviousWindow();
return;
}
static constexpr float alpha = 0.8f;
static constexpr float heading_alpha = 0.95f;
const float heading_height_unscaled =
((s_state.game_summary.beaten_time > 0 || s_state.game_summary.completed_time) ? 122.0f : 102.0f) +
((s_state.game_summary.num_unsupported_achievements > 0) ? 20.0f : 0.0f);
const ImVec4 background = ImGuiFullscreen::ModAlpha(UIStyle.BackgroundColor, alpha);
const ImVec4 heading_background = ImGuiFullscreen::ModAlpha(UIStyle.BackgroundColor, heading_alpha);
const ImVec2 display_size = ImGui::GetIO().DisplaySize;
const float heading_height = LayoutScale(heading_height_unscaled);
bool close_window = false;
if (ImGuiFullscreen::BeginFullscreenWindow(ImVec2(), ImVec2(display_size.x, heading_height), "achievements_heading",
heading_background, 0.0f, ImVec2(10.0f, 10.0f),
ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoDecoration |
ImGuiWindowFlags_NoScrollWithMouse))
{
const ImVec2 pos = ImGui::GetCursorScreenPos() + ImGui::GetStyle().FramePadding;
const float spacing = ImGuiFullscreen::LayoutScale(ImGuiFullscreen::LAYOUT_MENU_ITEM_TITLE_SUMMARY_SPACING);
const float image_size = LayoutScale(75.0f);
if (!s_state.game_icon.empty())
{
GPUTexture* badge = ImGuiFullscreen::GetCachedTextureAsync(s_state.game_icon);
if (badge)
{
ImGui::GetWindowDrawList()->AddImage(badge, pos, pos + ImVec2(image_size, image_size), ImVec2(0.0f, 0.0f),
ImVec2(1.0f, 1.0f), IM_COL32(255, 255, 255, 255));
}
}
float left = pos.x + image_size + LayoutScale(10.0f);
float right = pos.x + ImGuiFullscreen::GetMenuButtonAvailableWidth();
float top = pos.y;
ImDrawList* dl = ImGui::GetWindowDrawList();
SmallString text;
ImVec2 text_size;
close_window = (ImGuiFullscreen::FloatingButton(ICON_FA_SQUARE_XMARK, 10.0f, 10.0f, 1.0f, 0.0f, true) ||
ImGuiFullscreen::WantsToCloseMenu());
const ImRect title_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.LargeFontSize));
text.assign(s_state.game_title);
if (rc_client_get_hardcore_enabled(s_state.client))
text.append(TRANSLATE_SV("Achievements", " (Hardcore Mode)"));
top += UIStyle.LargeFontSize + spacing;
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, title_bb.Min, title_bb.Max,
ImGui::GetColorU32(ImGuiCol_Text), text, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &title_bb);
const ImRect summary_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.MediumFontSize));
if (s_state.game_summary.num_core_achievements > 0)
{
text.assign(ICON_EMOJI_UNLOCKED " ");
if (s_state.game_summary.num_unlocked_achievements == s_state.game_summary.num_core_achievements)
{
text.append(TRANSLATE_PLURAL_SSTR("Achievements", "You have unlocked all achievements and earned %n points!",
"Point count", s_state.game_summary.points_unlocked));
}
else
{
text.append_format(
TRANSLATE_FS("Achievements",
"You have unlocked {0} of {1} achievements, earning {2} of {3} possible points."),
s_state.game_summary.num_unlocked_achievements, s_state.game_summary.num_core_achievements,
s_state.game_summary.points_unlocked, s_state.game_summary.points_core);
}
}
else
{
text.format(ICON_FA_BAN " {}", TRANSLATE_SV("Achievements", "This game has no achievements."));
}
top += UIStyle.MediumFontSize + spacing;
RenderShadowedTextClipped(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, summary_bb.Min,
summary_bb.Max,
ImGui::GetColorU32(ImGuiFullscreen::DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text])),
text, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &summary_bb);
if (s_state.game_summary.num_unsupported_achievements)
{
text.format("{} {}", ICON_EMOJI_WARNING,
TRANSLATE_PLURAL_SSTR(
"Achievements", "%n achievements are not supported by DuckStation and cannot be unlocked.",
"Unsupported achievement count", s_state.game_summary.num_unsupported_achievements));
const ImRect unsupported_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.MediumFontSize));
RenderShadowedTextClipped(
UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, unsupported_bb.Min, unsupported_bb.Max,
ImGui::GetColorU32(ImGuiFullscreen::DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text])), text, nullptr,
ImVec2(0.0f, 0.0f), 0.0f, &unsupported_bb);
top += UIStyle.MediumFontSize + spacing;
}
if (s_state.game_summary.beaten_time > 0 || s_state.game_summary.completed_time > 0)
{
text.assign(ICON_EMOJI_CHECKMARK_BUTTON " ");
if (s_state.game_summary.beaten_time > 0)
{
const std::string beaten_time =
Host::FormatNumber(Host::NumberFormatType::ShortDate, static_cast<s64>(s_state.game_summary.beaten_time));
if (s_state.game_summary.completed_time > 0)
{
const std::string completion_time =
Host::FormatNumber(Host::NumberFormatType::ShortDate, static_cast<s64>(s_state.game_summary.beaten_time));
text.append_format(TRANSLATE_FS("Achievements", "Game was beaten on {0}, and completed on {1}."), beaten_time,
completion_time);
}
else
{
text.append_format(TRANSLATE_FS("Achievements", "Game was beaten on {0}."), beaten_time);
}
}
else
{
const std::string completion_time =
Host::FormatNumber(Host::NumberFormatType::ShortDate, static_cast<s64>(s_state.game_summary.completed_time));
text.append_format(TRANSLATE_FS("Achievements", "Game was completed on {0}."), completion_time);
}
const ImRect beaten_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.MediumFontSize));
RenderShadowedTextClipped(
UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, beaten_bb.Min, beaten_bb.Max,
ImGui::GetColorU32(ImGuiFullscreen::DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text])), text, nullptr,
ImVec2(0.0f, 0.0f), 0.0f, &beaten_bb);
top += UIStyle.MediumFontSize + spacing;
}
if (s_state.game_summary.num_core_achievements > 0)
{
const float progress_height = LayoutScale(20.0f);
const float progress_rounding = LayoutScale(5.0f);
const ImRect progress_bb(ImVec2(left, top), ImVec2(right, top + progress_height));
const float fraction = static_cast<float>(s_state.game_summary.num_unlocked_achievements) /
static_cast<float>(s_state.game_summary.num_core_achievements);
dl->AddRectFilled(progress_bb.Min, progress_bb.Max, ImGui::GetColorU32(UIStyle.PrimaryDarkColor),
progress_rounding);
if (s_state.game_summary.num_unlocked_achievements > 0)
{
ImGui::RenderRectFilledRangeH(dl, progress_bb, ImGui::GetColorU32(UIStyle.SecondaryColor), 0.0f, fraction,
progress_rounding);
}
text.format("{}%", static_cast<u32>(std::round(fraction * 100.0f)));
text_size = UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.BoldFontWeight, FLT_MAX, 0.0f,
IMSTR_START_END(text));
const ImVec2 text_pos(progress_bb.Min.x + ((progress_bb.Max.x - progress_bb.Min.x) / 2.0f) - (text_size.x / 2.0f),
progress_bb.Min.y + ((progress_bb.Max.y - progress_bb.Min.y) / 2.0f) -
(text_size.y / 2.0f));
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, text_pos,
ImGui::GetColorU32(UIStyle.PrimaryTextColor), IMSTR_START_END(text));
}
}
ImGuiFullscreen::EndFullscreenWindow();
if (ImGuiFullscreen::IsFocusResetFromWindowChange())
ImGui::SetNextWindowScroll(ImVec2(0.0f, 0.0f));
if (ImGuiFullscreen::BeginFullscreenWindow(
ImVec2(0.0f, heading_height),
ImVec2(display_size.x, display_size.y - heading_height - LayoutScale(ImGuiFullscreen::LAYOUT_FOOTER_HEIGHT)),
"achievements", background, 0.0f,
ImVec2(ImGuiFullscreen::LAYOUT_MENU_WINDOW_X_PADDING, ImGuiFullscreen::LAYOUT_MENU_WINDOW_Y_PADDING), 0))
{
static bool buckets_collapsed[NUM_RC_CLIENT_ACHIEVEMENT_BUCKETS] = {};
static constexpr std::pair<const char*, const char*> bucket_names[NUM_RC_CLIENT_ACHIEVEMENT_BUCKETS] = {
{ICON_FA_TRIANGLE_EXCLAMATION, TRANSLATE_NOOP("Achievements", "Unknown")},
{ICON_FA_LOCK, TRANSLATE_NOOP("Achievements", "Locked")},
{ICON_FA_UNLOCK, TRANSLATE_NOOP("Achievements", "Unlocked")},
{ICON_FA_TRIANGLE_EXCLAMATION, TRANSLATE_NOOP("Achievements", "Unsupported")},
{ICON_FA_CIRCLE_QUESTION, TRANSLATE_NOOP("Achievements", "Unofficial")},
{ICON_EMOJI_UNLOCKED, TRANSLATE_NOOP("Achievements", "Recently Unlocked")},
{ICON_FA_STOPWATCH, TRANSLATE_NOOP("Achievements", "Active Challenges")},
{ICON_FA_RULER_HORIZONTAL, TRANSLATE_NOOP("Achievements", "Almost There")},
{ICON_FA_TRIANGLE_EXCLAMATION, TRANSLATE_NOOP("Achievements", "Unsynchronized")},
};
ImGuiFullscreen::ResetFocusHere();
ImGuiFullscreen::BeginMenuButtons();
for (u32 bucket_type : {RC_CLIENT_ACHIEVEMENT_BUCKET_ACTIVE_CHALLENGE,
RC_CLIENT_ACHIEVEMENT_BUCKET_RECENTLY_UNLOCKED, RC_CLIENT_ACHIEVEMENT_BUCKET_ALMOST_THERE,
RC_CLIENT_ACHIEVEMENT_BUCKET_UNLOCKED, RC_CLIENT_ACHIEVEMENT_BUCKET_LOCKED,
RC_CLIENT_ACHIEVEMENT_BUCKET_UNOFFICIAL, RC_CLIENT_ACHIEVEMENT_BUCKET_UNSUPPORTED})
{
for (u32 bucket_idx = 0; bucket_idx < s_state.achievement_list->num_buckets; bucket_idx++)
{
const rc_client_achievement_bucket_t& bucket = s_state.achievement_list->buckets[bucket_idx];
if (bucket.bucket_type != bucket_type)
continue;
DebugAssert(bucket.bucket_type < NUM_RC_CLIENT_ACHIEVEMENT_BUCKETS);
bool& bucket_collapsed = buckets_collapsed[bucket.bucket_type];
bucket_collapsed ^= ImGuiFullscreen::MenuHeadingButton(
TinyString::from_format("{} {}", bucket_names[bucket.bucket_type].first,
Host::TranslateToStringView("Achievements", bucket_names[bucket.bucket_type].second)),
bucket_collapsed ? ICON_FA_CHEVRON_DOWN : ICON_FA_CHEVRON_UP, UIStyle.MediumLargeFontSize);
if (!bucket_collapsed)
{
for (u32 i = 0; i < bucket.num_achievements; i++)
DrawAchievement(bucket.achievements[i]);
}
}
}
ImGuiFullscreen::EndMenuButtons();
}
ImGuiFullscreen::EndFullscreenWindow();
ImGuiFullscreen::SetFullscreenStatusText(std::array{
std::make_pair(ICON_PF_ACHIEVEMENTS_MISSABLE, TRANSLATE_SV("Achievements", "Missable")),
std::make_pair(ICON_PF_ACHIEVEMENTS_PROGRESSION, TRANSLATE_SV("Achievements", "Progression")),
std::make_pair(ICON_PF_ACHIEVEMENTS_WIN, TRANSLATE_SV("Achievements", "Win Condition")),
std::make_pair(ICON_FA_LOCK, TRANSLATE_SV("Achievements", "Locked")),
std::make_pair(ICON_EMOJI_UNLOCKED, TRANSLATE_SV("Achievements", "Unlocked")),
});
ImGuiFullscreen::SetFullscreenFooterText(
std::array{std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_XBOX_DPAD_UP_DOWN :
ICON_PF_ARROW_UP ICON_PF_ARROW_DOWN,
TRANSLATE_SV("Achievements", "Change Selection")),
std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_BUTTON_A : ICON_PF_ENTER,
TRANSLATE_SV("Achievements", "View Details")),
std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_BUTTON_B : ICON_PF_ESC,
TRANSLATE_SV("Achievements", "Back"))},
FullscreenUI::GetBackgroundAlpha());
if (close_window)
FullscreenUI::ReturnToPreviousWindow();
}
void Achievements::DrawAchievement(const rc_client_achievement_t* cheevo)
{
using ImGuiFullscreen::DarkerColor;
using ImGuiFullscreen::LayoutScale;
using ImGuiFullscreen::LayoutUnscale;
using ImGuiFullscreen::RenderShadowedTextClipped;
using ImGuiFullscreen::UIStyle;
static constexpr float progress_height_unscaled = 20.0f;
static constexpr float progress_spacing_unscaled = 5.0f;
static constexpr float progress_rounding_unscaled = 5.0f;
const float spacing = ImGuiFullscreen::LayoutScale(ImGuiFullscreen::LAYOUT_MENU_ITEM_TITLE_SUMMARY_SPACING);
const u32 text_color = ImGui::GetColorU32(UIStyle.SecondaryTextColor);
const u32 summary_color = ImGui::GetColorU32(DarkerColor(UIStyle.SecondaryTextColor));
const u32 rarity_color = ImGui::GetColorU32(DarkerColor(DarkerColor(UIStyle.SecondaryTextColor)));
const ImVec2 image_size = LayoutScale(50.0f, 50.0f);
const bool is_unlocked = (cheevo->state == RC_CLIENT_ACHIEVEMENT_STATE_UNLOCKED);
const std::string_view measured_progress(cheevo->measured_progress);
const bool is_measured = !is_unlocked && !measured_progress.empty();
const float unlock_rarity_height = spacing + UIStyle.MediumFontSize;
const ImVec2 points_template_size = UIStyle.Font->CalcTextSizeA(
UIStyle.MediumFontSize, UIStyle.NormalFontWeight, FLT_MAX, 0.0f, TRANSLATE("Achievements", "XXX points"));
const float avail_width = ImGuiFullscreen::GetMenuButtonAvailableWidth();
const size_t summary_length = std::strlen(cheevo->description);
const float summary_wrap_width = (avail_width - (image_size.x + spacing + spacing) - points_template_size.x);
const ImVec2 summary_text_size =
UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.NormalFontWeight, FLT_MAX, summary_wrap_width,
cheevo->description, cheevo->description + summary_length);
const float content_height = UIStyle.LargeFontSize + spacing + summary_text_size.y + unlock_rarity_height +
LayoutScale(is_measured ? progress_height_unscaled : 0.0f) +
LayoutScale(ImGuiFullscreen::LAYOUT_MENU_ITEM_EXTRA_HEIGHT);
ImRect bb;
bool visible, hovered;
const bool clicked = ImGuiFullscreen::MenuButtonFrame(TinyString::from_format("chv_{}", cheevo->id), content_height,
true, &bb, &visible, &hovered);
if (!visible)
return;
const std::string& badge_path =
GetCachedAchievementBadgePath(cheevo, cheevo->state != RC_CLIENT_ACHIEVEMENT_STATE_UNLOCKED);
if (!badge_path.empty())
{
GPUTexture* badge = ImGuiFullscreen::GetCachedTextureAsync(badge_path);
if (badge)
{
const ImRect image_bb = ImGuiFullscreen::CenterImage(ImRect(bb.Min, bb.Min + image_size), badge);
ImGui::GetWindowDrawList()->AddImage(badge, image_bb.Min, image_bb.Max, ImVec2(0.0f, 0.0f), ImVec2(1.0f, 1.0f),
IM_COL32(255, 255, 255, 255));
}
}
SmallString text;
const float midpoint = bb.Min.y + UIStyle.LargeFontSize + spacing;
text = TRANSLATE_PLURAL_SSTR("Achievements", "%n points", "Achievement points", cheevo->points);
const ImVec2 points_size =
UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.NormalFontWeight, FLT_MAX, 0.0f, IMSTR_START_END(text));
const float points_template_start = bb.Max.x - points_template_size.x;
const float points_start = points_template_start + ((points_template_size.x - points_size.x) * 0.5f);
std::string_view right_icon_text;
switch (cheevo->type)
{
case RC_CLIENT_ACHIEVEMENT_TYPE_MISSABLE:
right_icon_text = ICON_PF_ACHIEVEMENTS_MISSABLE;
break;
case RC_CLIENT_ACHIEVEMENT_TYPE_PROGRESSION:
right_icon_text = ICON_PF_ACHIEVEMENTS_PROGRESSION;
break;
case RC_CLIENT_ACHIEVEMENT_TYPE_WIN:
right_icon_text = ICON_PF_ACHIEVEMENTS_WIN;
break;
case RC_CLIENT_ACHIEVEMENT_TYPE_STANDARD:
default:
right_icon_text = is_unlocked ? ICON_EMOJI_UNLOCKED : ICON_FA_LOCK;
break;
}
const ImVec2 right_icon_size = UIStyle.Font->CalcTextSizeA(UIStyle.LargeFontSize, UIStyle.BoldFontWeight, FLT_MAX,
0.0f, IMSTR_START_END(right_icon_text));
const float text_start_x = bb.Min.x + image_size.x + LayoutScale(15.0f);
const ImRect title_bb(ImVec2(text_start_x, bb.Min.y), ImVec2(points_start, midpoint));
const ImRect summary_bb(ImVec2(text_start_x, midpoint), ImVec2(points_start, midpoint + summary_text_size.y));
const ImRect unlock_rarity_bb(summary_bb.Min.x, summary_bb.Max.y + spacing, summary_bb.Max.x,
summary_bb.Max.y + unlock_rarity_height);
const ImRect points_bb(ImVec2(points_start, midpoint), bb.Max);
const ImRect lock_bb(ImVec2(points_template_start + ((points_template_size.x - right_icon_size.x) * 0.5f), bb.Min.y),
ImVec2(bb.Max.x, midpoint));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, title_bb.Min, title_bb.Max,
text_color, cheevo->title, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &title_bb);
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, lock_bb.Min, lock_bb.Max,
text_color, right_icon_text, &right_icon_size, ImVec2(0.0f, 0.0f), 0.0f, &lock_bb);
RenderShadowedTextClipped(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, points_bb.Min,
points_bb.Max, summary_color, text, &points_size, ImVec2(0.0f, 0.0f), 0.0f, &points_bb);
if (cheevo->description && summary_length > 0)
{
RenderShadowedTextClipped(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, summary_bb.Min,
summary_bb.Max, summary_color, std::string_view(cheevo->description, summary_length),
&summary_text_size, ImVec2(0.0f, 0.0f), summary_wrap_width, &summary_bb);
}
const float rarity_to_display = IsHardcoreModeActive() ? cheevo->rarity_hardcore : cheevo->rarity;
if (is_unlocked)
{
const std::string date =
Host::FormatNumber(Host::NumberFormatType::LongDateTime, static_cast<s64>(cheevo->unlock_time));
text.format(TRANSLATE_FS("Achievements", "Unlocked: {} | {:.1f}% of players have this achievement"), date,
rarity_to_display);
RenderShadowedTextClipped(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, unlock_rarity_bb.Min,
unlock_rarity_bb.Max, rarity_color, text, nullptr, ImVec2(0.0f, 0.0f), 0.0f,
&unlock_rarity_bb);
}
else
{
text.format(TRANSLATE_FS("Achievements", "{:.1f}% of players have this achievement"), rarity_to_display);
RenderShadowedTextClipped(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, unlock_rarity_bb.Min,
unlock_rarity_bb.Max, rarity_color, text, nullptr, ImVec2(0.0f, 0.0f), 0.0f,
&unlock_rarity_bb);
}
if (!is_unlocked && is_measured)
{
ImDrawList* dl = ImGui::GetWindowDrawList();
const float progress_height = LayoutScale(progress_height_unscaled);
const float progress_spacing = LayoutScale(progress_spacing_unscaled);
const float progress_rounding = LayoutScale(progress_rounding_unscaled);
const ImRect progress_bb(summary_bb.Min.x, unlock_rarity_bb.Max.y + progress_spacing,
summary_bb.Max.x - progress_spacing,
unlock_rarity_bb.Max.y + progress_spacing + progress_height);
const float fraction = cheevo->measured_percent * 0.01f;
dl->AddRectFilled(progress_bb.Min, progress_bb.Max, ImGui::GetColorU32(ImGuiFullscreen::UIStyle.PrimaryDarkColor),
progress_rounding);
ImGui::RenderRectFilledRangeH(dl, progress_bb, ImGui::GetColorU32(ImGuiFullscreen::UIStyle.SecondaryColor), 0.0f,
fraction, progress_rounding);
const ImVec2 text_size = UIStyle.Font->CalcTextSizeA(UIStyle.MediumFontSize, UIStyle.NormalFontWeight, FLT_MAX,
0.0f, IMSTR_START_END(measured_progress));
const ImVec2 text_pos(progress_bb.Min.x + ((progress_bb.Max.x - progress_bb.Min.x) / 2.0f) - (text_size.x / 2.0f),
progress_bb.Min.y + ((progress_bb.Max.y - progress_bb.Min.y) / 2.0f) - (text_size.y / 2.0f));
dl->AddText(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.NormalFontWeight, text_pos,
ImGui::GetColorU32(ImGuiFullscreen::UIStyle.PrimaryTextColor), IMSTR_START_END(measured_progress));
}
if (clicked)
{
const SmallString url = SmallString::from_format(fmt::runtime(ACHEIVEMENT_DETAILS_URL_TEMPLATE), cheevo->id);
INFO_LOG("Opening achievement details: {}", url);
Host::OpenURL(url);
}
}
bool Achievements::PrepareLeaderboardsWindow()
{
auto lock = Achievements::GetLock();
rc_client_t* const client = s_state.client;
s_state.achievement_badge_paths = {};
CloseLeaderboard();
if (s_state.leaderboard_list)
rc_client_destroy_leaderboard_list(s_state.leaderboard_list);
s_state.leaderboard_list = rc_client_create_leaderboard_list(client, RC_CLIENT_LEADERBOARD_LIST_GROUPING_NONE);
if (!s_state.leaderboard_list)
{
ERROR_LOG("rc_client_create_leaderboard_list() returned null");
return false;
}
return true;
}
void Achievements::DrawLeaderboardsWindow()
{
using ImGuiFullscreen::DarkerColor;
using ImGuiFullscreen::LayoutScale;
using ImGuiFullscreen::RenderShadowedTextClipped;
using ImGuiFullscreen::UIStyle;
static constexpr float alpha = 0.8f;
static constexpr float heading_alpha = 0.95f;
static constexpr float heading_height_unscaled = 110.0f;
static constexpr float tab_height_unscaled = 50.0f;
const auto lock = Achievements::GetLock();
if (!s_state.leaderboard_list)
{
FullscreenUI::ReturnToPreviousWindow();
return;
}
const bool is_leaderboard_open = (s_state.open_leaderboard != nullptr);
bool close_leaderboard_on_exit = false;
SmallString text;
const ImVec4 background = ImGuiFullscreen::ModAlpha(ImGuiFullscreen::UIStyle.BackgroundColor, alpha);
const ImVec4 heading_background = ImGuiFullscreen::ModAlpha(ImGuiFullscreen::UIStyle.BackgroundColor, heading_alpha);
const ImVec2 display_size = ImGui::GetIO().DisplaySize;
const u32 text_color = ImGui::GetColorU32(ImGuiCol_Text);
const float spacing = LayoutScale(10.0f);
const float spacing_small = ImFloor(spacing * 0.5f);
float heading_height = LayoutScale(heading_height_unscaled);
if (is_leaderboard_open)
{
heading_height += spacing * 2.0f + LayoutScale(tab_height_unscaled) + spacing * 2.0f;
heading_height += UIStyle.LargeFontSize;
}
const float rank_column_width =
UIStyle.Font
->CalcTextSizeA(UIStyle.LargeFontSize, UIStyle.BoldFontWeight, std::numeric_limits<float>::max(), -1.0f, "99999")
.x;
const float name_column_width = UIStyle.Font
->CalcTextSizeA(UIStyle.LargeFontSize, UIStyle.BoldFontWeight,
std::numeric_limits<float>::max(), -1.0f, "WWWWWWWWWWWWWWWWWWWWWW")
.x;
const float time_column_width = UIStyle.Font
->CalcTextSizeA(UIStyle.LargeFontSize, UIStyle.BoldFontWeight,
std::numeric_limits<float>::max(), -1.0f, "WWWWWWWWWWW")
.x;
const float column_spacing = spacing * 2.0f;
if (ImGuiFullscreen::BeginFullscreenWindow(ImVec2(), ImVec2(display_size.x, heading_height), "leaderboards_heading",
heading_background, 0.0f, ImVec2(10.0f, 10.0f),
ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoDecoration |
ImGuiWindowFlags_NoScrollWithMouse))
{
const ImVec2 heading_pos = ImGui::GetCursorScreenPos() + ImGui::GetStyle().FramePadding;
const float image_size = LayoutScale(85.0f);
if (!s_state.game_icon.empty())
{
GPUTexture* badge = ImGuiFullscreen::GetCachedTextureAsync(s_state.game_icon);
if (badge)
{
ImGui::GetWindowDrawList()->AddImage(badge, heading_pos, heading_pos + ImVec2(image_size, image_size),
ImVec2(0.0f, 0.0f), ImVec2(1.0f, 1.0f), IM_COL32(255, 255, 255, 255));
}
}
float left = heading_pos.x + image_size + spacing;
float right = heading_pos.x + ImGuiFullscreen::GetMenuButtonAvailableWidth();
float top = heading_pos.y;
if (!is_leaderboard_open)
{
if (ImGuiFullscreen::FloatingButton(ICON_FA_SQUARE_XMARK, 10.0f, 10.0f, 1.0f, 0.0f, true) ||
ImGuiFullscreen::WantsToCloseMenu())
{
FullscreenUI::ReturnToPreviousWindow();
}
}
else
{
if (ImGuiFullscreen::FloatingButton(ICON_FA_SQUARE_CARET_LEFT, 10.0f, 10.0f, 1.0f, 0.0f, true) ||
ImGuiFullscreen::WantsToCloseMenu())
{
close_leaderboard_on_exit = true;
}
}
const ImRect title_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.LargeFontSize));
text.assign(Achievements::GetGameTitle());
top += UIStyle.LargeFontSize + spacing_small;
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, title_bb.Min, title_bb.Max,
text_color, text, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &title_bb);
u32 summary_color;
if (is_leaderboard_open)
{
const ImRect subtitle_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.LargeFontSize));
text.assign(s_state.open_leaderboard->title);
top += UIStyle.LargeFontSize + spacing_small;
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, subtitle_bb.Min,
subtitle_bb.Max,
ImGui::GetColorU32(DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text])), text, nullptr,
ImVec2(0.0f, 0.0f), 0.0f, &subtitle_bb);
text.assign(s_state.open_leaderboard->description);
summary_color = ImGui::GetColorU32(DarkerColor(DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text])));
}
else
{
u32 count = 0;
for (u32 i = 0; i < s_state.leaderboard_list->num_buckets; i++)
count += s_state.leaderboard_list->buckets[i].num_leaderboards;
text = TRANSLATE_PLURAL_SSTR("Achievements", "This game has %n leaderboards.", "Leaderboard count", count);
summary_color = ImGui::GetColorU32(DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text]));
}
const ImRect summary_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.MediumFontSize));
top += UIStyle.MediumFontSize + spacing_small;
RenderShadowedTextClipped(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, summary_bb.Min,
summary_bb.Max, summary_color, text, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &summary_bb);
if (!is_leaderboard_open && !Achievements::IsHardcoreModeActive())
{
const ImRect hardcore_warning_bb(ImVec2(left, top), ImVec2(right, top + UIStyle.MediumFontSize));
top += UIStyle.MediumFontSize + spacing_small;
text.format(
ICON_EMOJI_WARNING " {}",
TRANSLATE_SV("Achievements",
"Submitting scores is disabled because hardcore mode is off. Leaderboards are read-only."));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.MediumFontSize, UIStyle.BoldFontWeight, hardcore_warning_bb.Min,
hardcore_warning_bb.Max,
ImGui::GetColorU32(DarkerColor(DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text]))),
text, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &hardcore_warning_bb);
}
if (is_leaderboard_open)
{
const float avail_width = ImGuiFullscreen::GetMenuButtonAvailableWidth();
const float tab_width = avail_width * 0.2f;
const float tab_spacing = LayoutScale(20.0f);
const float tab_left_padding = (avail_width - ((tab_width * 2.0f) + tab_spacing)) * 0.5f;
ImGui::SetCursorScreenPos(ImVec2(heading_pos.x + tab_left_padding, top + spacing * 2.0f));
ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, LayoutScale(ImGuiFullscreen::LAYOUT_MENU_WINDOW_X_PADDING,
ImGuiFullscreen::LAYOUT_MENU_WINDOW_Y_PADDING));
if (ImGui::IsKeyPressed(ImGuiKey_GamepadDpadLeft, false) ||
ImGui::IsKeyPressed(ImGuiKey_NavGamepadTweakSlow, false) || ImGui::IsKeyPressed(ImGuiKey_LeftArrow, false) ||
ImGui::IsKeyPressed(ImGuiKey_GamepadDpadRight, false) ||
ImGui::IsKeyPressed(ImGuiKey_NavGamepadTweakFast, false) || ImGui::IsKeyPressed(ImGuiKey_RightArrow, false))
{
s_state.is_showing_all_leaderboard_entries = !s_state.is_showing_all_leaderboard_entries;
ImGuiFullscreen::QueueResetFocus(ImGuiFullscreen::FocusResetType::ViewChanged);
}
for (const bool show_all : {false, true})
{
const std::string_view title =
show_all ? TRANSLATE_SV("Achievements", "Show Best") : TRANSLATE_SV("Achievements", "Show Nearby");
if (ImGuiFullscreen::NavTab(title, s_state.is_showing_all_leaderboard_entries == show_all, true, tab_width))
{
s_state.is_showing_all_leaderboard_entries = show_all;
ImGuiFullscreen::QueueResetFocus(ImGuiFullscreen::FocusResetType::ViewChanged);
}
if (!show_all)
ImGui::SetCursorPosX(ImGui::GetCursorPosX() + tab_spacing);
}
ImGui::PopStyleVar();
ImGui::SetCursorPos(ImVec2(0.0f, ImGui::GetCursorPosY() + LayoutScale(tab_height_unscaled) + spacing * 2.0f));
ImVec2 column_heading_pos = ImGui::GetCursorScreenPos();
float end_x = column_heading_pos.x + ImGui::GetContentRegionAvail().x;
column_heading_pos.x += LayoutScale(ImGuiFullscreen::LAYOUT_MENU_WINDOW_X_PADDING);
end_x -= LayoutScale(ImGuiFullscreen::LAYOUT_MENU_WINDOW_X_PADDING);
column_heading_pos.x += LayoutScale(ImGuiFullscreen::LAYOUT_MENU_BUTTON_X_PADDING);
end_x -= LayoutScale(ImGuiFullscreen::LAYOUT_MENU_BUTTON_X_PADDING);
const u32 heading_color = ImGui::GetColorU32(DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text]));
const float midpoint = column_heading_pos.y + UIStyle.LargeFontSize + LayoutScale(4.0f);
float text_start_x = column_heading_pos.x;
const ImRect rank_bb(ImVec2(text_start_x, column_heading_pos.y), ImVec2(end_x, midpoint));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, rank_bb.Min, rank_bb.Max,
heading_color, TRANSLATE_SV("Achievements", "Rank"), nullptr, ImVec2(0.0f, 0.0f), 0.0f,
&rank_bb);
text_start_x += rank_column_width + column_spacing;
const ImRect user_bb(ImVec2(text_start_x, column_heading_pos.y), ImVec2(end_x, midpoint));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, user_bb.Min, user_bb.Max,
heading_color, TRANSLATE_SV("Achievements", "Name"), nullptr, ImVec2(0.0f, 0.0f), 0.0f,
&user_bb);
text_start_x += name_column_width + column_spacing;
static const char* value_headings[NUM_RC_CLIENT_LEADERBOARD_FORMATS] = {
TRANSLATE_NOOP("Achievements", "Time"),
TRANSLATE_NOOP("Achievements", "Score"),
TRANSLATE_NOOP("Achievements", "Value"),
};
const ImRect score_bb(ImVec2(text_start_x, column_heading_pos.y), ImVec2(end_x, midpoint));
RenderShadowedTextClipped(
UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, score_bb.Min, score_bb.Max, heading_color,
Host::TranslateToStringView(
"Achievements",
value_headings[std::min<u8>(s_state.open_leaderboard->format, NUM_RC_CLIENT_LEADERBOARD_FORMATS - 1)]),
nullptr, ImVec2(0.0f, 0.0f), 0.0f, &score_bb);
text_start_x += time_column_width + column_spacing;
const ImRect date_bb(ImVec2(text_start_x, column_heading_pos.y), ImVec2(end_x, midpoint));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, date_bb.Min, date_bb.Max,
heading_color, TRANSLATE_SV("Achievements", "Date Submitted"), nullptr,
ImVec2(0.0f, 0.0f), 0.0f, &date_bb);
const float line_thickness = LayoutScale(1.0f);
const float line_padding = LayoutScale(5.0f);
const ImVec2 line_start(column_heading_pos.x, column_heading_pos.y + UIStyle.LargeFontSize + line_padding);
const ImVec2 line_end(end_x, line_start.y);
ImGui::GetWindowDrawList()->AddLine(line_start, line_end, ImGui::GetColorU32(ImGuiCol_TextDisabled),
line_thickness);
ImGui::Dummy(ImVec2(end_x - column_heading_pos.x, column_heading_pos.y - line_end.y));
}
}
ImGuiFullscreen::EndFullscreenWindow();
if (ImGuiFullscreen::IsFocusResetFromWindowChange())
ImGui::SetNextWindowScroll(ImVec2(0.0f, 0.0f));
if (!is_leaderboard_open)
{
if (ImGuiFullscreen::BeginFullscreenWindow(
ImVec2(0.0f, heading_height),
ImVec2(display_size.x, display_size.y - heading_height - LayoutScale(ImGuiFullscreen::LAYOUT_FOOTER_HEIGHT)),
"leaderboards", background, 0.0f,
ImVec2(ImGuiFullscreen::LAYOUT_MENU_WINDOW_X_PADDING, ImGuiFullscreen::LAYOUT_MENU_WINDOW_Y_PADDING), 0))
{
ImGuiFullscreen::ResetFocusHere();
ImGuiFullscreen::BeginMenuButtons();
for (u32 bucket_index = 0; bucket_index < s_state.leaderboard_list->num_buckets; bucket_index++)
{
const rc_client_leaderboard_bucket_t& bucket = s_state.leaderboard_list->buckets[bucket_index];
for (u32 i = 0; i < bucket.num_leaderboards; i++)
DrawLeaderboardListEntry(bucket.leaderboards[i]);
}
ImGuiFullscreen::EndMenuButtons();
}
ImGuiFullscreen::EndFullscreenWindow();
ImGuiFullscreen::SetFullscreenFooterText(
std::array{std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_XBOX_DPAD_UP_DOWN :
ICON_PF_ARROW_UP ICON_PF_ARROW_DOWN,
TRANSLATE_SV("Achievements", "Change Selection")),
std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_BUTTON_A : ICON_PF_ENTER,
TRANSLATE_SV("Achievements", "Open Leaderboard")),
std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_BUTTON_B : ICON_PF_ESC,
TRANSLATE_SV("Achievements", "Back"))},
FullscreenUI::GetBackgroundAlpha());
}
else
{
if (ImGuiFullscreen::BeginFullscreenWindow(
ImVec2(0.0f, heading_height),
ImVec2(display_size.x, display_size.y - heading_height - LayoutScale(ImGuiFullscreen::LAYOUT_FOOTER_HEIGHT)),
"leaderboard", background, 0.0f,
ImVec2(ImGuiFullscreen::LAYOUT_MENU_WINDOW_X_PADDING, ImGuiFullscreen::LAYOUT_MENU_WINDOW_Y_PADDING), 0))
{
ImGuiFullscreen::BeginMenuButtons();
ImGuiFullscreen::ResetFocusHere();
if (!s_state.is_showing_all_leaderboard_entries)
{
if (s_state.leaderboard_nearby_entries)
{
for (u32 i = 0; i < s_state.leaderboard_nearby_entries->num_entries; i++)
{
DrawLeaderboardEntry(s_state.leaderboard_nearby_entries->entries[i], i,
static_cast<s32>(i) == s_state.leaderboard_nearby_entries->user_index,
rank_column_width, name_column_width, time_column_width, column_spacing);
}
}
else
{
const ImVec2 pos_min(0.0f, heading_height);
const ImVec2 pos_max(display_size.x, display_size.y);
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, pos_min, pos_max,
text_color,
TRANSLATE_SV("Achievements", "Downloading leaderboard data, please wait..."),
nullptr, ImVec2(0.5f, 0.5f), 0.0f);
}
}
else
{
for (const rc_client_leaderboard_entry_list_t* list : s_state.leaderboard_entry_lists)
{
for (u32 i = 0; i < list->num_entries; i++)
{
DrawLeaderboardEntry(list->entries[i], i, static_cast<s32>(i) == list->user_index, rank_column_width,
name_column_width, time_column_width, column_spacing);
}
}
bool visible;
text.format(ICON_FA_HOURGLASS_HALF " {}", TRANSLATE_SV("Achievements", "Loading..."));
ImGuiFullscreen::MenuButtonWithVisibilityQuery(text, text, {}, {}, &visible, false);
if (visible && !s_state.leaderboard_fetch_handle)
FetchNextLeaderboardEntries();
}
ImGuiFullscreen::EndMenuButtons();
}
ImGuiFullscreen::EndFullscreenWindow();
ImGuiFullscreen::SetFullscreenFooterText(
std::array{std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_XBOX_DPAD_LEFT_RIGHT :
ICON_PF_ARROW_LEFT ICON_PF_ARROW_RIGHT,
TRANSLATE_SV("Achievements", "Change Page")),
std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_XBOX_DPAD_UP_DOWN :
ICON_PF_ARROW_UP ICON_PF_ARROW_DOWN,
TRANSLATE_SV("Achievements", "Change Selection")),
std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_BUTTON_A : ICON_PF_ENTER,
TRANSLATE_SV("Achievements", "View Profile")),
std::make_pair(ImGuiFullscreen::IsGamepadInputSource() ? ICON_PF_BUTTON_B : ICON_PF_ESC,
TRANSLATE_SV("Achievements", "Back"))},
FullscreenUI::GetBackgroundAlpha());
}
if (close_leaderboard_on_exit)
FullscreenUI::BeginTransition(&CloseLeaderboard);
}
void Achievements::DrawLeaderboardEntry(const rc_client_leaderboard_entry_t& entry, u32 index, bool is_self,
float rank_column_width, float name_column_width, float time_column_width,
float column_spacing)
{
using ImGuiFullscreen::LayoutScale;
using ImGuiFullscreen::RenderShadowedTextClipped;
using ImGuiFullscreen::UIStyle;
ImRect bb;
bool visible, hovered;
bool pressed = ImGuiFullscreen::MenuButtonFrame(entry.user, UIStyle.LargeFontSize, true, &bb, &visible, &hovered);
if (!visible)
return;
const float midpoint = bb.Min.y + UIStyle.LargeFontSize + LayoutScale(4.0f);
float text_start_x = bb.Min.x;
SmallString text;
text.format("{}", entry.rank);
const u32 text_color =
is_self ?
IM_COL32(255, 242, 0, 255) :
ImGui::GetColorU32(((index % 2) == 0) ? ImGuiFullscreen::DarkerColor(ImGui::GetStyle().Colors[ImGuiCol_Text]) :
ImGui::GetStyle().Colors[ImGuiCol_Text]);
const ImRect rank_bb(ImVec2(text_start_x, bb.Min.y), ImVec2(bb.Max.x, midpoint));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, rank_bb.Min, rank_bb.Max,
text_color, text, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &rank_bb);
text_start_x += rank_column_width + column_spacing;
const float icon_size = bb.Max.y - bb.Min.y;
const ImRect icon_bb(ImVec2(text_start_x, bb.Min.y), ImVec2(bb.Max.x, midpoint));
GPUTexture* icon_tex = nullptr;
if (auto it = std::find_if(s_state.leaderboard_user_icon_paths.begin(), s_state.leaderboard_user_icon_paths.end(),
[&entry](const auto& it) { return it.first == &entry; });
it != s_state.leaderboard_user_icon_paths.end())
{
if (!it->second.empty())
icon_tex = ImGuiFullscreen::GetCachedTextureAsync(it->second);
}
else
{
std::string path = Achievements::GetLeaderboardUserBadgePath(&entry);
if (!path.empty())
{
icon_tex = ImGuiFullscreen::GetCachedTextureAsync(path);
s_state.leaderboard_user_icon_paths.emplace_back(&entry, std::move(path));
}
}
if (icon_tex)
{
const ImRect fit_icon_bb =
ImGuiFullscreen::CenterImage(ImRect(icon_bb.Min, icon_bb.Min + ImVec2(icon_size, icon_size)), icon_tex);
ImGui::GetWindowDrawList()->AddImage(reinterpret_cast<ImTextureID>(icon_tex), fit_icon_bb.Min, fit_icon_bb.Max);
}
const ImRect user_bb(ImVec2(text_start_x + column_spacing + icon_size, bb.Min.y), ImVec2(bb.Max.x, midpoint));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, user_bb.Min, user_bb.Max,
text_color, entry.user, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &user_bb);
text_start_x += name_column_width + column_spacing;
const ImRect score_bb(ImVec2(text_start_x, bb.Min.y), ImVec2(bb.Max.x, midpoint));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, score_bb.Min, score_bb.Max,
text_color, entry.display, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &score_bb);
text_start_x += time_column_width + column_spacing;
const ImRect time_bb(ImVec2(text_start_x, bb.Min.y), ImVec2(bb.Max.x, midpoint));
const std::string submit_time =
Host::FormatNumber(Host::NumberFormatType::LongDateTime, static_cast<s64>(entry.submitted));
RenderShadowedTextClipped(UIStyle.Font, UIStyle.LargeFontSize, UIStyle.BoldFontWeight, time_bb.Min, time_bb.Max,
text_color, submit_time, nullptr, ImVec2(0.0f, 0.0f), 0.0f, &time_bb);
if (pressed)
{
const SmallString url = SmallString::from_format(fmt::runtime(PROFILE_DETAILS_URL_TEMPLATE), entry.user);
INFO_LOG("Opening profile details: {}", url);
Host::OpenURL(url);
}
}
void Achievements::DrawLeaderboardListEntry(const rc_client_leaderboard_t* lboard)
{
using ImGuiFullscreen::LayoutScale;
using ImGuiFullscreen::MenuButton;
using ImGuiFullscreen::UIStyle;
SmallString title;
title.format("{}##{}", lboard->title, lboard->id);
std::string_view summary;
if (lboard->description && lboard->description[0] != '\0')
summary = lboard->description;
if (MenuButton(title, summary))
FullscreenUI::BeginTransition([id = lboard->id]() { OpenLeaderboardById(id); });
}
#endif
void Achievements::OpenLeaderboard(const rc_client_leaderboard_t* lboard)
{
DEV_LOG("Opening leaderboard '{}' ({})", lboard->title, lboard->id);
CloseLeaderboard();
s_state.open_leaderboard = lboard;
s_state.is_showing_all_leaderboard_entries = false;
s_state.leaderboard_fetch_handle = rc_client_begin_fetch_leaderboard_entries_around_user(
s_state.client, lboard->id, LEADERBOARD_NEARBY_ENTRIES_TO_FETCH, LeaderboardFetchNearbyCallback, nullptr);
ImGuiFullscreen::QueueResetFocus(ImGuiFullscreen::FocusResetType::Other);
}
bool Achievements::OpenLeaderboardById(u32 leaderboard_id)
{
const rc_client_leaderboard_t* lb = rc_client_get_leaderboard_info(s_state.client, leaderboard_id);
if (!lb)
return false;
OpenLeaderboard(lb);
return true;
}
u32 Achievements::GetOpenLeaderboardId()
{
return s_state.open_leaderboard ? s_state.open_leaderboard->id : 0;
}
bool Achievements::IsShowingAllLeaderboardEntries()
{
return s_state.is_showing_all_leaderboard_entries;
}
const std::vector<rc_client_leaderboard_entry_list_t*>& Achievements::GetLeaderboardEntryLists()
{
return s_state.leaderboard_entry_lists;
}
const rc_client_leaderboard_entry_list_t* Achievements::GetLeaderboardNearbyEntries()
{
return s_state.leaderboard_nearby_entries;
}
void Achievements::LeaderboardFetchNearbyCallback(int result, const char* error_message,
rc_client_leaderboard_entry_list_t* list, rc_client_t* client,
void* callback_userdata)
{
const auto lock = GetLock();
s_state.leaderboard_fetch_handle = nullptr;
if (result != RC_OK)
{
ImGuiFullscreen::ShowToast(TRANSLATE("Achievements", "Leaderboard download failed"), error_message);
CloseLeaderboard();
return;
}
if (s_state.leaderboard_nearby_entries)
rc_client_destroy_leaderboard_entry_list(s_state.leaderboard_nearby_entries);
s_state.leaderboard_nearby_entries = list;
ImGuiFullscreen::QueueResetFocus(ImGuiFullscreen::FocusResetType::Other);
}
void Achievements::LeaderboardFetchAllCallback(int result, const char* error_message,
rc_client_leaderboard_entry_list_t* list, rc_client_t* client,
void* callback_userdata)
{
const auto lock = GetLock();
s_state.leaderboard_fetch_handle = nullptr;
if (result != RC_OK)
{
ImGuiFullscreen::ShowToast(TRANSLATE("Achievements", "Leaderboard download failed"), error_message);
CloseLeaderboard();
return;
}
if (s_state.leaderboard_entry_lists.empty())
ImGuiFullscreen::QueueResetFocus(ImGuiFullscreen::FocusResetType::Other);
s_state.leaderboard_entry_lists.push_back(list);
}
void Achievements::FetchNextLeaderboardEntries()
{
u32 start = 1;
for (rc_client_leaderboard_entry_list_t* list : s_state.leaderboard_entry_lists)
start += list->num_entries;
DEV_LOG("Fetching entries {} to {}", start, start + LEADERBOARD_ALL_FETCH_SIZE);
if (s_state.leaderboard_fetch_handle)
rc_client_abort_async(s_state.client, s_state.leaderboard_fetch_handle);
s_state.leaderboard_fetch_handle =
rc_client_begin_fetch_leaderboard_entries(s_state.client, s_state.open_leaderboard->id, start,
LEADERBOARD_ALL_FETCH_SIZE, LeaderboardFetchAllCallback, nullptr);
}
void Achievements::CloseLeaderboard()
{
s_state.leaderboard_user_icon_paths.clear();
for (auto iter = s_state.leaderboard_entry_lists.rbegin(); iter != s_state.leaderboard_entry_lists.rend(); ++iter)
rc_client_destroy_leaderboard_entry_list(*iter);
s_state.leaderboard_entry_lists.clear();
if (s_state.leaderboard_nearby_entries)
{
rc_client_destroy_leaderboard_entry_list(s_state.leaderboard_nearby_entries);
s_state.leaderboard_nearby_entries = nullptr;
}
if (s_state.leaderboard_fetch_handle)
{
rc_client_abort_async(s_state.client, s_state.leaderboard_fetch_handle);
s_state.leaderboard_fetch_handle = nullptr;
}
s_state.open_leaderboard = nullptr;
ImGuiFullscreen::QueueResetFocus(ImGuiFullscreen::FocusResetType::ViewChanged);
}
#if defined(_WIN32)
#include "common/windows_headers.h"
#elif !defined(__ANDROID__)
#include <unistd.h>
#endif
#include "common/thirdparty/SmallVector.h"
#include "common/thirdparty/aes.h"
#ifndef __ANDROID__
static TinyString GetLoginEncryptionMachineKey()
{
TinyString ret;
#ifdef _WIN32
HKEY hKey;
DWORD error;
if ((error = RegOpenKeyExW(HKEY_LOCAL_MACHINE, L"SOFTWARE\\Microsoft\\Cryptography", 0, KEY_READ, &hKey)) !=
ERROR_SUCCESS)
{
WARNING_LOG("Open SOFTWARE\\Microsoft\\Cryptography failed for machine key failed: {}", error);
return ret;
}
DWORD machine_guid_length;
if ((error = RegGetValueA(hKey, NULL, "MachineGuid", RRF_RT_REG_SZ, NULL, NULL, &machine_guid_length)) !=
ERROR_SUCCESS)
{
WARNING_LOG("Get MachineGuid failed: {}", error);
RegCloseKey(hKey);
return ret;
}
ret.resize(machine_guid_length);
if ((error = RegGetValueA(hKey, NULL, "MachineGuid", RRF_RT_REG_SZ, NULL, ret.data(), &machine_guid_length)) !=
ERROR_SUCCESS ||
machine_guid_length <= 1)
{
WARNING_LOG("Read MachineGuid failed: {}", error);
ret = {};
RegCloseKey(hKey);
return ret;
}
ret.resize(machine_guid_length);
RegCloseKey(hKey);
#else
#if defined(__linux__)
std::optional<std::string> machine_id = FileSystem::ReadFileToString("/etc/machine-id");
if (machine_id.has_value())
ret = std::string_view(machine_id.value());
#elif defined(__APPLE__)
const struct timespec ts{};
uuid_t uuid{};
if (gethostuuid(uuid, &ts) == 0)
ret.append_hex(uuid, sizeof(uuid), false);
#endif
if (ret.empty())
{
WARNING_LOG("Falling back to gethostid()");
const long hostid = gethostid();
ret.format("{:08X}", hostid);
}
#endif
return ret;
}
#endif
static std::array<u8, 32> GetLoginEncryptionKey(std::string_view username)
{
static constexpr u32 EXTRA_ROUNDS = 100;
SHA256Digest digest;
#ifndef __ANDROID__
if (!EmuFolders::IsRunningInPortableMode())
{
const TinyString machine_key = GetLoginEncryptionMachineKey();
if (!machine_key.empty())
digest.Update(machine_key.cbspan());
else
WARNING_LOG("Failed to get machine key, token will be decipherable.");
}
#endif
digest.Update(username.data(), username.length());
std::array<u8, 32> key = digest.Final();
for (u32 i = 0; i < EXTRA_ROUNDS; i++)
key = SHA256Digest::GetDigest(key);
return key;
}
TinyString Achievements::EncryptLoginToken(std::string_view token, std::string_view username)
{
TinyString ret;
if (token.empty() || username.empty())
return ret;
const auto key = GetLoginEncryptionKey(username);
std::array<u32, AES_KEY_SCHEDULE_SIZE> key_schedule;
aes_key_setup(&key[0], key_schedule.data(), 128);
llvm::SmallVector<u8, 64> data(reinterpret_cast<const u8*>(token.data()),
reinterpret_cast<const u8*>(token.data() + token.length()));
data.resize(Common::AlignUpPow2(token.length(), AES_BLOCK_SIZE), 0);
aes_encrypt_cbc(data.data(), data.size(), data.data(), key_schedule.data(), 128, &key[16]);
const std::span<const u8> data_span(data.data(), data.size());
ret.resize(static_cast<u32>(StringUtil::EncodedBase64Length(data_span)));
StringUtil::EncodeBase64(ret.span(), data_span);
return ret;
}
TinyString Achievements::DecryptLoginToken(std::string_view encrypted_token, std::string_view username)
{
TinyString ret;
if (encrypted_token.empty() || username.empty())
return ret;
const size_t encrypted_data_length = StringUtil::DecodedBase64Length(encrypted_token);
if (encrypted_data_length == 0 || (encrypted_data_length % AES_BLOCK_SIZE) != 0)
return ret;
const auto key = GetLoginEncryptionKey(username);
std::array<u32, AES_KEY_SCHEDULE_SIZE> key_schedule;
aes_key_setup(&key[0], key_schedule.data(), 128);
llvm::SmallVector<u8, 64> encrypted_data;
encrypted_data.resize(encrypted_data_length);
if (StringUtil::DecodeBase64(std::span<u8>(encrypted_data.data(), encrypted_data.size()), encrypted_token) !=
encrypted_data_length)
{
WARNING_LOG("Failed to base64 decode encrypted login token.");
return ret;
}
aes_decrypt_cbc(encrypted_data.data(), encrypted_data.size(), encrypted_data.data(), key_schedule.data(), 128,
&key[16]);
const size_t real_length =
StringUtil::Strnlen(reinterpret_cast<const char*>(encrypted_data.data()), encrypted_data_length);
ret.append(reinterpret_cast<const char*>(encrypted_data.data()), static_cast<u32>(real_length));
return ret;
}
std::string Achievements::GetHashDatabasePath()
{
return Path::Combine(EmuFolders::Cache, "achievement_gamedb.cache");
}
std::string Achievements::GetProgressDatabasePath()
{
return Path::Combine(EmuFolders::Cache, "achievement_progress.cache");
}
void Achievements::BeginRefreshHashDatabase()
{
INFO_LOG("Starting hash database refresh...");
CancelHashDatabaseRequests();
s_state.fetch_hash_library_request =
rc_client_begin_fetch_hash_library(s_state.client, RC_CONSOLE_PLAYSTATION, FetchHashLibraryCallback, nullptr);
s_state.fetch_all_progress_request =
rc_client_begin_fetch_all_user_progress(s_state.client, RC_CONSOLE_PLAYSTATION, FetchAllProgressCallback, nullptr);
if (!s_state.fetch_hash_library_request || !s_state.fetch_hash_library_request)
{
ERROR_LOG("Failed to create hash database refresh requests.");
CancelHashDatabaseRequests();
}
}
void Achievements::FetchHashLibraryCallback(int result, const char* error_message, rc_client_hash_library_t* list,
rc_client_t* client, void* callback_userdata)
{
s_state.fetch_hash_library_request = nullptr;
if (result != RC_OK)
{
ERROR_LOG("Fetch hash library failed: {}: {}", rc_error_str(result), error_message);
CancelHashDatabaseRequests();
return;
}
s_state.fetch_hash_library_result = list;
FinishRefreshHashDatabase();
}
void Achievements::FetchAllProgressCallback(int result, const char* error_message, rc_client_all_user_progress_t* list,
rc_client_t* client, void* callback_userdata)
{
s_state.fetch_all_progress_request = nullptr;
if (result != RC_OK)
{
ERROR_LOG("Fetch all progress failed: {}: {}", rc_error_str(result), error_message);
CancelHashDatabaseRequests();
return;
}
s_state.fetch_all_progress_result = list;
FinishRefreshHashDatabase();
}
void Achievements::CancelHashDatabaseRequests()
{
if (s_state.fetch_all_progress_result)
{
rc_client_destroy_all_user_progress(s_state.fetch_all_progress_result);
s_state.fetch_all_progress_result = nullptr;
}
if (s_state.fetch_all_progress_request)
{
rc_client_abort_async(s_state.client, s_state.fetch_all_progress_request);
s_state.fetch_all_progress_request = nullptr;
}
if (s_state.fetch_hash_library_result)
{
rc_client_destroy_hash_library(s_state.fetch_hash_library_result);
s_state.fetch_hash_library_result = nullptr;
}
if (s_state.fetch_hash_library_request)
{
rc_client_abort_async(s_state.client, s_state.fetch_hash_library_request);
s_state.fetch_hash_library_request = nullptr;
}
}
void Achievements::FinishRefreshHashDatabase()
{
if (!s_state.fetch_hash_library_result || !s_state.fetch_all_progress_result)
{
return;
}
BuildHashDatabase(s_state.fetch_hash_library_result, s_state.fetch_all_progress_result);
BuildProgressDatabase(s_state.fetch_all_progress_result);
rc_client_destroy_all_user_progress(s_state.fetch_all_progress_result);
s_state.fetch_all_progress_result = nullptr;
rc_client_destroy_hash_library(s_state.fetch_hash_library_result);
s_state.fetch_hash_library_result = nullptr;
GameList::UpdateAllAchievementData();
Host::OnAchievementsAllProgressRefreshed();
}
bool Achievements::RefreshAllProgressDatabase(Error* error)
{
if (!IsLoggedIn())
{
Error::SetStringView(error, TRANSLATE_SV("Achievements", "User is not logged in."));
return false;
}
if (s_state.fetch_hash_library_request || s_state.fetch_all_progress_request || s_state.refresh_all_progress_request)
{
Error::SetStringView(error, TRANSLATE_SV("Achievements", "Progress is already being updated."));
return false;
}
s_state.refresh_all_progress_request = rc_client_begin_fetch_all_user_progress(s_state.client, RC_CONSOLE_PLAYSTATION,
RefreshAllProgressCallback, nullptr);
return true;
}
void Achievements::RefreshAllProgressCallback(int result, const char* error_message,
rc_client_all_user_progress_t* list, rc_client_t* client,
void* callback_userdata)
{
s_state.refresh_all_progress_request = nullptr;
if (result != RC_OK)
{
Host::ReportErrorAsync(TRANSLATE_SV("Achievements", "Error"),
fmt::format("{}: {}\n{}", TRANSLATE_SV("Achievements", "Refresh all progress failed"),
rc_error_str(result), error_message));
return;
}
BuildProgressDatabase(list);
rc_client_destroy_all_user_progress(list);
GameList::UpdateAllAchievementData();
Host::OnAchievementsAllProgressRefreshed();
if (FullscreenUI::IsInitialized())
{
GPUThread::RunOnThread([]() {
if (!FullscreenUI::IsInitialized())
return;
ImGuiFullscreen::ShowToast({}, TRANSLATE_STR("Achievements", "Updated achievement progress database."),
Host::OSD_INFO_DURATION);
});
}
}
void Achievements::BuildHashDatabase(const rc_client_hash_library_t* hashlib,
const rc_client_all_user_progress_t* allprog)
{
std::vector<HashDatabaseEntry> dbentries;
dbentries.reserve(hashlib->num_entries);
for (const rc_client_hash_library_entry_t& entry :
std::span<const rc_client_hash_library_entry_t>(hashlib->entries, hashlib->num_entries))
{
HashDatabaseEntry dbentry;
dbentry.game_id = entry.game_id;
dbentry.num_achievements = 0;
if (StringUtil::DecodeHex(dbentry.hash, entry.hash) != GAME_HASH_LENGTH)
{
WARNING_LOG("Invalid hash '{}' in game ID {}", entry.hash, entry.game_id);
continue;
}
if (std::any_of(dbentries.begin(), dbentries.end(),
[&dbentry](const HashDatabaseEntry& e) { return (e.hash == dbentry.hash); }))
{
WARNING_LOG("Duplicate hash {}", entry.hash);
continue;
}
dbentries.push_back(dbentry);
}
for (const rc_client_all_user_progress_entry_t& entry :
std::span<const rc_client_all_user_progress_entry_t>(allprog->entries, allprog->num_entries))
{
bool found_one = false;
for (HashDatabaseEntry& dbentry : dbentries)
{
if (dbentry.game_id == entry.game_id)
{
dbentry.num_achievements = entry.num_achievements;
found_one = true;
}
}
if (!found_one)
WARNING_LOG("All progress contained game ID {} without hash", entry.game_id);
}
s_state.hashdb_entries = std::move(dbentries);
s_state.hashdb_loaded = true;
Error error;
if (!SortAndSaveHashDatabase(&error))
ERROR_LOG("Failed to sort/save hash database from server: {}", error.GetDescription());
}
bool Achievements::CreateHashDatabaseFromSeedDatabase(const std::string& path, Error* error)
{
std::optional<std::string> yaml_data = Host::ReadResourceFileToString("achievement_hashlib.yaml", false, error);
if (!yaml_data.has_value())
{
Error::SetStringView(error, "Seed database is missing.");
return false;
}
const ryml::Tree yaml =
ryml::parse_in_place(to_csubstr(path), c4::substr(reinterpret_cast<char*>(yaml_data->data()), yaml_data->size()));
const ryml::ConstNodeRef root = yaml.rootref();
if (root.empty())
{
Error::SetStringView(error, "Seed database is empty.");
return false;
}
std::vector<HashDatabaseEntry> dbentries;
if (const ryml::ConstNodeRef hashes = root.find_child(to_csubstr("hashes")); hashes.valid())
{
dbentries.reserve(hashes.num_children());
for (const ryml::ConstNodeRef& current : hashes.cchildren())
{
const std::string_view hash = to_stringview(current.key());
const std::optional<u32> game_id = StringUtil::FromChars<u32>(to_stringview(current.val()));
if (!game_id.has_value())
{
WARNING_LOG("Invalid game ID {} in hash {}", to_stringview(current.val()), hash);
continue;
}
HashDatabaseEntry dbentry;
dbentry.game_id = game_id.value();
dbentry.num_achievements = 0;
if (StringUtil::DecodeHex(dbentry.hash, hash) != GAME_HASH_LENGTH)
{
WARNING_LOG("Invalid hash '{}' in game ID {}", hash, game_id.value());
continue;
}
dbentries.push_back(dbentry);
}
}
if (const ryml::ConstNodeRef achievements = root.find_child(to_csubstr("achievements")); achievements.valid())
{
for (const ryml::ConstNodeRef& current : achievements.cchildren())
{
const std::optional<u32> game_id = StringUtil::FromChars<u32>(to_stringview(current.key()));
const std::optional<u32> num_achievements = StringUtil::FromChars<u32>(to_stringview(current.val()));
if (!game_id.has_value() || !num_achievements.has_value())
{
WARNING_LOG("Invalid achievements entry in game ID {}", to_stringview(current.key()));
continue;
}
bool found_one = false;
for (HashDatabaseEntry& dbentry : dbentries)
{
if (dbentry.game_id == game_id.value())
{
dbentry.num_achievements = num_achievements.value();
found_one = true;
}
}
if (!found_one)
WARNING_LOG("Seed database contained game ID {} without hash", game_id.value());
}
}
if (dbentries.empty())
{
Error::SetStringView(error, "Parsed seed database was empty");
return false;
}
s_state.hashdb_entries = std::move(dbentries);
s_state.hashdb_loaded = true;
Error save_error;
if (!SortAndSaveHashDatabase(&save_error))
ERROR_LOG("Failed to sort/save hash database from server: {}", save_error.GetDescription());
return true;
}
bool Achievements::SortAndSaveHashDatabase(Error* error)
{
s_state.hashdb_entries.shrink_to_fit();
std::sort(s_state.hashdb_entries.begin(), s_state.hashdb_entries.end(),
[](const HashDatabaseEntry& lhs, const HashDatabaseEntry& rhs) {
return std::memcmp(lhs.hash.data(), rhs.hash.data(), GAME_HASH_LENGTH) < 0;
});
FileSystem::AtomicRenamedFile fp = FileSystem::CreateAtomicRenamedFile(GetHashDatabasePath().c_str(), error);
if (!fp)
{
Error::AddPrefix(error, "Failed to open cache for writing: ");
return false;
}
BinaryFileWriter writer(fp.get());
writer.WriteU32(static_cast<u32>(s_state.hashdb_entries.size()));
for (const HashDatabaseEntry& entry : s_state.hashdb_entries)
{
writer.Write(entry.hash.data(), GAME_HASH_LENGTH);
writer.WriteU32(entry.game_id);
writer.WriteU32(entry.num_achievements);
}
if (!writer.Flush(error) || !FileSystem::CommitAtomicRenamedFile(fp, error))
{
Error::AddPrefix(error, "Failed to write cache: ");
return false;
}
INFO_LOG("Wrote {} games to hash database", s_state.hashdb_entries.size());
return true;
}
bool Achievements::LoadHashDatabase(const std::string& path, Error* error)
{
FileSystem::ManagedCFilePtr fp = FileSystem::OpenManagedCFile(path.c_str(), "rb", error);
if (!fp)
{
Error::AddPrefix(error, "Failed to open cache for reading: ");
return false;
}
BinaryFileReader reader(fp.get());
const u32 count = reader.ReadU32();
constexpr size_t entry_size = (GAME_HASH_LENGTH + sizeof(u32) + sizeof(u32));
if (static_cast<s64>((count * entry_size) + sizeof(u32)) > FileSystem::FSize64(fp.get()))
{
Error::SetStringFmt(error, "Invalid entry count: {}", count);
return false;
}
s_state.hashdb_entries.resize(count);
for (HashDatabaseEntry& entry : s_state.hashdb_entries)
{
reader.Read(entry.hash.data(), entry.hash.size());
reader.ReadU32(&entry.game_id);
reader.ReadU32(&entry.num_achievements);
}
if (reader.HasError())
{
Error::SetStringView(error, "Error while reading cache");
s_state.hashdb_entries = {};
return false;
}
VERBOSE_LOG("Loaded {} entries from cached hash database", s_state.hashdb_entries.size());
return true;
}
const Achievements::HashDatabaseEntry* Achievements::LookupGameHash(const GameHash& hash)
{
if (!s_state.hashdb_loaded) [[unlikely]]
{
std::unique_lock lock(s_state.mutex);
if (!s_state.hashdb_loaded)
{
Error error;
std::string path = GetHashDatabasePath();
const bool hashdb_exists = FileSystem::FileExists(path.c_str());
if (!hashdb_exists || !LoadHashDatabase(path, &error))
{
if (hashdb_exists)
WARNING_LOG("Failed to load hash database: {}", error.GetDescription());
if (!CreateHashDatabaseFromSeedDatabase(path, &error))
ERROR_LOG("Failed to create hash database from seed database: {}", error.GetDescription());
}
}
s_state.hashdb_loaded = true;
}
const auto iter = std::lower_bound(s_state.hashdb_entries.begin(), s_state.hashdb_entries.end(), hash,
[](const HashDatabaseEntry& entry, const GameHash& search) {
return (std::memcmp(entry.hash.data(), search.data(), GAME_HASH_LENGTH) < 0);
});
return (iter != s_state.hashdb_entries.end() && std::memcmp(iter->hash.data(), hash.data(), GAME_HASH_LENGTH) == 0) ?
&(*iter) :
nullptr;
}
void Achievements::PreloadHashDatabase()
{
const std::string hash_database_path = GetHashDatabasePath();
const std::string progress_database_path = GetProgressDatabasePath();
bool has_hash_database = (s_state.hashdb_loaded && !s_state.hashdb_entries.empty());
const bool has_progress_database = FileSystem::FileExists(progress_database_path.c_str());
if (!has_hash_database && has_progress_database && FileSystem::FileExists(hash_database_path.c_str()))
{
VERBOSE_LOG("Trying to load hash database from {}", hash_database_path);
Error error;
has_hash_database = LoadHashDatabase(hash_database_path, &error);
if (!has_hash_database)
ERROR_LOG("Failed to load hash database: {}", error.GetDescription());
}
s_state.hashdb_loaded = true;
if (has_hash_database && has_progress_database)
return;
BeginRefreshHashDatabase();
}
FileSystem::ManagedCFilePtr Achievements::OpenProgressDatabase(bool for_write, bool truncate, Error* error)
{
const std::string path = GetProgressDatabasePath();
const FileSystem::FileShareMode share_mode =
for_write ? FileSystem::FileShareMode::DenyReadWrite : FileSystem::FileShareMode::DenyWrite;
#ifdef _WIN32
const char* mode = for_write ? (truncate ? "w+b" : "r+b") : "rb";
#else
const char* mode = truncate ? "w+b" : "r+b";
#endif
FileSystem::ManagedCFilePtr fp = FileSystem::OpenManagedSharedCFile(path.c_str(), mode, share_mode, error);
if (fp)
return fp;
if (errno == ENOENT)
{
if (!for_write)
return nullptr;
mode = "w+b";
fp = FileSystem::OpenManagedSharedCFile(path.c_str(), mode, share_mode, error);
if (fp)
return fp;
}
if (errno != EACCES)
return nullptr;
Timer timer;
while (timer.GetTimeMilliseconds() <= 100.0f)
{
fp = FileSystem::OpenManagedSharedCFile(path.c_str(), mode, share_mode, error);
if (fp)
return fp;
if (errno != EACCES)
return nullptr;
}
Error::SetStringView(error, "Timed out while trying to open progress database.");
return nullptr;
}
void Achievements::BuildProgressDatabase(const rc_client_all_user_progress_t* allprog)
{
Error error;
FileSystem::ManagedCFilePtr fp = OpenProgressDatabase(true, true, &error);
if (!fp)
{
ERROR_LOG("Failed to build progress database: {}", error.GetDescription());
return;
}
#ifdef HAS_POSIX_FILE_LOCK
FileSystem::POSIXLock lock(fp.get());
#endif
u32 games_with_unlocks = 0;
for (u32 i = 0; i < allprog->num_entries; i++)
{
games_with_unlocks += BoolToUInt32(
(allprog->entries[i].num_unlocked_achievements + allprog->entries[i].num_unlocked_achievements_hardcore) > 0);
}
BinaryFileWriter writer(fp.get());
writer.WriteU32(games_with_unlocks);
if (games_with_unlocks > 0)
{
for (const rc_client_all_user_progress_entry_t& entry :
std::span<const rc_client_all_user_progress_entry_t>(allprog->entries, allprog->num_entries))
{
if ((entry.num_unlocked_achievements + entry.num_unlocked_achievements_hardcore) == 0)
continue;
writer.WriteU32(entry.game_id);
writer.WriteU16(Truncate16(entry.num_unlocked_achievements));
writer.WriteU16(Truncate16(entry.num_unlocked_achievements_hardcore));
}
}
if (!writer.Flush(&error))
ERROR_LOG("Failed to write progress database: {}", error.GetDescription());
}
void Achievements::UpdateProgressDatabase()
{
if (rc_client_get_spectator_mode_enabled(s_state.client))
return;
rc_client_achievement_list_t* const achievements =
rc_client_create_achievement_list(s_state.client, RC_CLIENT_ACHIEVEMENT_CATEGORY_CORE, 0);
u32 num_achievements = 0;
u32 achievements_unlocked = 0;
u32 achievements_unlocked_hardcore = 0;
if (achievements)
{
for (const rc_client_achievement_bucket_t& bucket :
std::span<const rc_client_achievement_bucket_t>(achievements->buckets, achievements->num_buckets))
{
for (const rc_client_achievement_t* achievement :
std::span<const rc_client_achievement_t*>(bucket.achievements, bucket.num_achievements))
{
achievements_unlocked += BoolToUInt32((achievement->unlocked & RC_CLIENT_ACHIEVEMENT_UNLOCKED_SOFTCORE) != 0);
achievements_unlocked_hardcore +=
BoolToUInt32((achievement->unlocked & RC_CLIENT_ACHIEVEMENT_UNLOCKED_HARDCORE) != 0);
}
num_achievements += bucket.num_achievements;
}
rc_client_destroy_achievement_list(achievements);
}
if (s_state.game_hash.has_value())
{
GameList::UpdateAchievementData(s_state.game_hash.value(), s_state.game_id, num_achievements, achievements_unlocked,
achievements_unlocked_hardcore);
}
System::QueueAsyncTask([game_id = s_state.game_id, achievements_unlocked, achievements_unlocked_hardcore]() {
Error error;
FileSystem::ManagedCFilePtr fp = OpenProgressDatabase(true, false, &error);
const s64 size = fp ? FileSystem::FSize64(fp.get(), &error) : -1;
if (!fp || size < 0)
{
ERROR_LOG("Failed to update progress database: {}", error.GetDescription());
return;
}
#ifdef HAS_POSIX_FILE_LOCK
FileSystem::POSIXLock lock(fp.get());
#endif
BinaryFileReader reader(fp.get());
const u32 game_count = (size > 0) ? reader.ReadU32() : 0;
s64 found_offset = -1;
for (u32 i = 0; i < game_count; i++)
{
const u32 check_game_id = reader.ReadU32();
if (check_game_id == game_id)
{
const u16 current_achievements_unlocked = reader.ReadU16();
const u16 current_achievements_unlocked_hardcore = reader.ReadU16();
if (current_achievements_unlocked == achievements_unlocked &&
current_achievements_unlocked_hardcore == achievements_unlocked_hardcore)
{
VERBOSE_LOG("No update to progress database needed for game {}", game_id);
return;
}
found_offset = FileSystem::FTell64(fp.get()) - sizeof(u16) - sizeof(u16);
break;
}
if (!FileSystem::FSeek64(fp.get(), sizeof(u16) + sizeof(u16), SEEK_CUR, &error)) [[unlikely]]
{
ERROR_LOG("Failed to seek in progress database: {}", error.GetDescription());
return;
}
}
if (reader.HasError())
{
ERROR_LOG("Failed to read in progress database: {}", error.GetDescription());
return;
}
BinaryFileWriter writer(fp.get());
if (found_offset > 0)
{
INFO_LOG("Updating game {} with {}/{} unlocked", game_id, achievements_unlocked, achievements_unlocked_hardcore);
if (!FileSystem::FSeek64(fp.get(), found_offset, SEEK_SET, &error))
{
ERROR_LOG("Failed to write seek in progress database: {}", error.GetDescription());
return;
}
writer.WriteU16(Truncate16(achievements_unlocked));
writer.WriteU16(Truncate16(achievements_unlocked_hardcore));
}
else
{
if (achievements_unlocked == 0 && achievements_unlocked_hardcore == 0)
return;
INFO_LOG("Appending game {} with {}/{} unlocked", game_id, achievements_unlocked, achievements_unlocked_hardcore);
if (size == 0)
{
writer.WriteU32(1);
}
else
{
if (!FileSystem::FSeek64(fp.get(), 0, SEEK_SET, &error) || !writer.WriteU32(game_count + 1) ||
!FileSystem::FSeek64(fp.get(), 0, SEEK_END, &error))
{
ERROR_LOG("Failed to write seek/update header in progress database: {}", error.GetDescription());
return;
}
}
writer.WriteU32(game_id);
writer.WriteU16(Truncate16(achievements_unlocked));
writer.WriteU16(Truncate16(achievements_unlocked_hardcore));
}
if (!writer.Flush(&error))
{
ERROR_LOG("Failed to write count in progress database: {}", error.GetDescription());
return;
}
});
}
void Achievements::ClearProgressDatabase()
{
std::string path = GetProgressDatabasePath();
if (FileSystem::FileExists(path.c_str()))
{
INFO_LOG("Deleting progress database {}", path);
Error error;
if (!FileSystem::DeleteFile(path.c_str(), &error))
ERROR_LOG("Failed to delete progress database: {}", error.GetDescription());
}
GameList::UpdateAllAchievementData();
}
Achievements::ProgressDatabase::ProgressDatabase() = default;
Achievements::ProgressDatabase::~ProgressDatabase() = default;
bool Achievements::ProgressDatabase::Load(Error* error)
{
FileSystem::ManagedCFilePtr fp = OpenProgressDatabase(false, false, error);
if (!fp)
return false;
#ifdef HAS_POSIX_FILE_LOCK
FileSystem::POSIXLock lock(fp.get());
#endif
BinaryFileReader reader(fp.get());
const u32 count = reader.ReadU32();
constexpr size_t entry_size = (sizeof(u32) + sizeof(u16) + sizeof(u16));
if (static_cast<s64>((count * entry_size) + sizeof(u32)) > FileSystem::FSize64(fp.get()))
{
Error::SetStringFmt(error, "Invalid entry count: {}", count);
return false;
}
m_entries.reserve(count);
for (u32 i = 0; i < count; i++)
{
const Entry entry = {.game_id = reader.ReadU32(),
.num_achievements_unlocked = reader.ReadU16(),
.num_hc_achievements_unlocked = reader.ReadU16()};
if (std::any_of(m_entries.begin(), m_entries.end(),
[id = entry.game_id](const Entry& e) { return (e.game_id == id); }))
{
WARNING_LOG("Duplicate game ID {}", entry.game_id);
continue;
}
m_entries.push_back(entry);
}
m_entries.shrink_to_fit();
std::sort(m_entries.begin(), m_entries.end(),
[](const Entry& lhs, const Entry& rhs) { return (lhs.game_id < rhs.game_id); });
return true;
}
const Achievements::ProgressDatabase::Entry* Achievements::ProgressDatabase::LookupGame(u32 game_id) const
{
const auto iter = std::lower_bound(m_entries.begin(), m_entries.end(), game_id,
[](const Entry& entry, u32 search) { return (entry.game_id < search); });
return (iter != m_entries.end() && iter->game_id == game_id) ? &(*iter) : nullptr;
}
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
#include "common/windows_headers.h"
#include "rc_client_raintegration.h"
namespace Achievements {
static void FinishLoadRAIntegration();
static void FinishLoadRAIntegrationOnCPUThread();
static void RAIntegrationBeginLoadCallback(int result, const char* error_message, rc_client_t* client, void* userdata);
static void RAIntegrationEventHandler(const rc_client_raintegration_event_t* event, rc_client_t* client);
static void RAIntegrationWriteMemoryCallback(uint32_t address, uint8_t* buffer, uint32_t num_bytes,
rc_client_t* client);
static void RAIntegrationGetGameNameCallback(char* buffer, uint32_t buffer_size, rc_client_t* client);
}
bool Achievements::IsUsingRAIntegration()
{
return s_state.using_raintegration;
}
bool Achievements::IsRAIntegrationAvailable()
{
return (FileSystem::FileExists(Path::Combine(EmuFolders::AppRoot, "RA_Integration-x64.dll").c_str()) ||
FileSystem::FileExists(Path::Combine(EmuFolders::AppRoot, "RA_Integration.dll").c_str()));
}
bool Achievements::IsRAIntegrationInitializing()
{
return (s_state.using_raintegration && (s_state.load_raintegration_request || s_state.raintegration_loading));
}
void Achievements::BeginLoadRAIntegration()
{
s_state.using_raintegration = true;
s_state.raintegration_loading = true;
const std::wstring wapproot = StringUtil::UTF8StringToWideString(EmuFolders::AppRoot);
s_state.load_raintegration_request = rc_client_begin_load_raintegration_deferred(
s_state.client, wapproot.c_str(), RAIntegrationBeginLoadCallback, nullptr);
}
void Achievements::RAIntegrationBeginLoadCallback(int result, const char* error_message, rc_client_t* client,
void* userdata)
{
s_state.load_raintegration_request = nullptr;
if (result != RC_OK)
{
s_state.raintegration_loading = false;
std::string message = fmt::format("Failed to load RAIntegration:\n{}", error_message ? error_message : "");
Host::ReportErrorAsync("RAIntegration Error", message);
return;
}
INFO_COLOR_LOG(StrongGreen, "RAIntegration DLL loaded, initializing.");
Host::RunOnUIThread(&Achievements::FinishLoadRAIntegration);
}
void Achievements::FinishLoadRAIntegration()
{
const std::optional<WindowInfo> wi = Host::GetTopLevelWindowInfo();
const auto lock = GetLock();
if (!s_state.using_raintegration)
return;
const char* error_message = nullptr;
const int res = rc_client_finish_load_raintegration(
s_state.client,
(wi.has_value() && wi->type == WindowInfo::Type::Win32) ? static_cast<HWND>(wi->window_handle) : NULL,
"DuckStation", g_scm_tag_str, &error_message);
if (res != RC_OK)
{
std::string message = fmt::format("Failed to initialize RAIntegration:\n{}", error_message ? error_message : "");
Host::ReportErrorAsync("RAIntegration Error", message);
s_state.using_raintegration = false;
Host::RunOnCPUThread(&Achievements::FinishLoadRAIntegrationOnCPUThread);
return;
}
rc_client_raintegration_set_write_memory_function(s_state.client, RAIntegrationWriteMemoryCallback);
rc_client_raintegration_set_console_id(s_state.client, RC_CONSOLE_PLAYSTATION);
rc_client_raintegration_set_get_game_name_function(s_state.client, RAIntegrationGetGameNameCallback);
rc_client_raintegration_set_event_handler(s_state.client, RAIntegrationEventHandler);
Host::OnRAIntegrationMenuChanged();
Host::RunOnCPUThread(&Achievements::FinishLoadRAIntegrationOnCPUThread);
}
void Achievements::FinishLoadRAIntegrationOnCPUThread()
{
const auto lock = GetLock();
s_state.raintegration_loading = false;
FinishInitialize();
}
void Achievements::UnloadRAIntegration()
{
DebugAssert(s_state.using_raintegration && s_state.client);
if (s_state.load_raintegration_request)
{
rc_client_abort_async(s_state.client, s_state.load_raintegration_request);
s_state.load_raintegration_request = nullptr;
}
s_state.http_downloader->WaitForAllRequests();
s_state.http_downloader.reset();
s_state.raintegration_loading = false;
s_state.using_raintegration = false;
Host::RunOnUIThread([client = std::exchange(s_state.client, nullptr)]() {
rc_client_unload_raintegration(client);
rc_client_destroy(client);
});
Host::OnRAIntegrationMenuChanged();
}
void Achievements::RAIntegrationEventHandler(const rc_client_raintegration_event_t* event, rc_client_t* client)
{
switch (event->type)
{
case RC_CLIENT_RAINTEGRATION_EVENT_MENUITEM_CHECKED_CHANGED:
case RC_CLIENT_RAINTEGRATION_EVENT_MENU_CHANGED:
{
Host::OnRAIntegrationMenuChanged();
}
break;
case RC_CLIENT_RAINTEGRATION_EVENT_HARDCORE_CHANGED:
{
Host::RunOnCPUThread([]() {
const auto lock = GetLock();
OnHardcoreModeChanged(rc_client_get_hardcore_enabled(s_state.client) != 0, false, false);
});
}
break;
case RC_CLIENT_RAINTEGRATION_EVENT_PAUSE:
{
Host::RunOnCPUThread([]() { System::PauseSystem(true); });
}
break;
default:
ERROR_LOG("Unhandled RAIntegration event {}", static_cast<u32>(event->type));
break;
}
}
void Achievements::RAIntegrationWriteMemoryCallback(uint32_t address, uint8_t* buffer, uint32_t num_bytes,
rc_client_t* client)
{
if ((address + num_bytes) > 0x200400U) [[unlikely]]
return;
llvm::SmallVector<u8, 16> data(buffer, buffer + num_bytes);
Host::RunOnCPUThread([address, data = std::move(data)]() {
u8* src = (address >= 0x200000U) ? CPU::g_state.scratchpad.data() : Bus::g_ram;
const u32 offset = (address & Bus::RAM_2MB_MASK);
switch (data.size())
{
case 1:
std::memcpy(&src[offset], data.data(), 1);
break;
case 2:
std::memcpy(&src[offset], data.data(), 2);
break;
case 4:
std::memcpy(&src[offset], data.data(), 4);
break;
default:
[[unlikely]] std::memcpy(&src[offset], data.data(), data.size());
break;
}
});
}
void Achievements::RAIntegrationGetGameNameCallback(char* buffer, uint32_t buffer_size, rc_client_t* client)
{
StringUtil::Strlcpy(buffer, System::GetGameTitle(), buffer_size);
}
#else
bool Achievements::IsUsingRAIntegration()
{
return false;
}
bool Achievements::IsRAIntegrationAvailable()
{
return false;
}
bool Achievements::IsRAIntegrationInitializing()
{
return false;
}
#endif
