mirror of
https://github.com/hrydgard/ppsspp.git
synced 2026-09-03 03:05:18 +02:00
System.cpp stamped BootState::Complete unconditionally after InitGPU(), overwriting the Failed that InitGPU sets when GPU_Init() fails - after it has already run CPU_Shutdown(). PSP_InitUpdate then took the success path on a core that no longer existed, down to a null Memory::base, and the first guest access dereferenced it. InitGPU now reports failure and both callers honor it. (The libretro path had the same problem from the other direction: it calls InitGPU after the Failed check.) HandleAssert called g_assertCancelCallback directly on the IDCANCEL path, without the null check its own BreakIntoPSPDebugger() helper does - and EmuScreen clears the callback when a game is unloaded. So any assert after returning to the menu turned "Cancel: skip and break into PPSSPP debugger" into a null jump, from the one button whose entire purpose is surviving the assert. __CheatDoState registered the cheat event type when the savestate had no CwCheat section, but never scheduled it. CoreTiming::DoState has already swapped in the state's event queue by then, which doesn't contain one either - so loading an old savestate silently killed cheats, and the enable/disable polling with them, for the rest of the session. Achievements::ChangeUMD set g_isIdentifying and returned without clearing it when hashing failed, leaving IsBlockingExecution() true forever - EmuScreen stops running the CPU and the game is frozen until restart. Reachable from a disc swap on any ISO whose PARAM.SFO or EBOOT.BIN can't be read. x64Analyzer routed opcode 0x88 into the write path but had no case for it, so it hit the default, logged from inside the crash handler, and failed. 0x88 is exactly what the x64 JIT emits for a guest sb, so MemFault could never skip or ignore a bad byte store the way it can a word one. Handle the 8-bit forms, and drop the 0x8a/0x8b cases in the read path that the same 0xF0 mask made unreachable. Covered by a new CheckAnalyze case, which fails without this change. 314 pspautotests pass, all unit tests pass.
1199 lines
42 KiB
C++
1199 lines
42 KiB
C++
// SPDX-FileCopyrightText: 2019-2022 Connor McLaughlin <stenzek@gmail.com>
|
|
// SPDX-License-Identifier: (GPL-2.0 OR GPL-3.0 OR CC-BY-NC-ND-4.0)
|
|
|
|
// Derived from Duckstation's RetroAchievements implementation by stenzek as can be seen
|
|
// above, relicensed to GPL 2.0.
|
|
|
|
// Actually after the rc_client rewrite, barely anything of that remains.
|
|
|
|
// The PSP hash function:
|
|
// md5_init
|
|
// md5_hash(PSP_GAME/PARAM.SFO)
|
|
// md5_hash(PSP_GAME/EBOOT.BIN)
|
|
// hash = md5_finalize()
|
|
|
|
// To test RAIntegration, get the DLL here: https://github.com/RetroAchievements/RAIntegration/releases
|
|
// Then just place it next to PPSSPP and enable RAIntegration in PPSSPP achivement settings, then restart it.
|
|
|
|
#include <algorithm>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "ext/rcheevos/include/rcheevos.h"
|
|
#include "ext/rcheevos/include/rc_client.h"
|
|
#include "ext/rcheevos/include/rc_client_raintegration.h"
|
|
#include "ext/rcheevos/include/rc_api_user.h"
|
|
#include "ext/rcheevos/include/rc_api_info.h"
|
|
#include "ext/rcheevos/include/rc_api_request.h"
|
|
#include "ext/rcheevos/include/rc_api_runtime.h"
|
|
|
|
#ifdef SYSTEM_RAPIDJSON
|
|
#include <rapidjson/document.h>
|
|
#else
|
|
#include "ext/rapidjson/include/rapidjson/document.h"
|
|
#endif
|
|
|
|
#include "Common/Crypto/md5.h"
|
|
#include "Common/Log.h"
|
|
#include "Common/File/Path.h"
|
|
#include "Common/Net/HTTPRequest.h"
|
|
#include "Common/Net/HTTPClient.h"
|
|
#include "Common/System/OSD.h"
|
|
#include "Common/System/System.h"
|
|
#include "Common/System/NativeApp.h"
|
|
#include "Common/TimeUtil.h"
|
|
#include "Common/Data/Text/I18n.h"
|
|
#include "Common/Serialize/Serializer.h"
|
|
#include "Common/Serialize/SerializeFuncs.h"
|
|
#include "Common/StringUtils.h"
|
|
#include "Common/UI/IconCache.h"
|
|
#include "Core/ELF/ParamSFO.h"
|
|
|
|
#include "Core/MemMap.h"
|
|
#include "Core/Config.h"
|
|
#include "Core/Core.h"
|
|
#include "Core/System.h"
|
|
#include "Core/FileSystems/BlockDevices.h"
|
|
#include "Core/FileSystems/ISOFileSystem.h"
|
|
#include "Core/RetroAchievements.h"
|
|
|
|
#if RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
|
|
#include "Windows/MainWindow.h"
|
|
|
|
#endif
|
|
|
|
static const char *const RAINTEGRATION_FILENAME = "RAIntegration.dll";
|
|
|
|
static bool HashISOFile(ISOFileSystem *fs, const std::string filename, md5_context *md5) {
|
|
int handle = fs->OpenFile(filename, FILEACCESS_READ);
|
|
if (handle < 0) {
|
|
return false;
|
|
}
|
|
|
|
uint32_t sz = (uint32_t)fs->SeekFile(handle, 0, FILEMOVE_END);
|
|
fs->SeekFile(handle, 0, FILEMOVE_BEGIN);
|
|
if (!sz) {
|
|
return false;
|
|
}
|
|
|
|
auto buffer = std::make_unique<uint8_t[]>(sz);
|
|
if (fs->ReadFile(handle, buffer.get(), sz) != sz) {
|
|
return false;
|
|
}
|
|
fs->CloseFile(handle);
|
|
|
|
ppsspp_md5_update(md5, buffer.get(), sz);
|
|
return true;
|
|
}
|
|
|
|
static std::string FormatRCheevosMD5(uint8_t digest[16]) {
|
|
char hashStr[33];
|
|
/* NOTE: sizeof(hash) is 4 because it's still treated like a pointer, despite specifying a size */
|
|
snprintf(hashStr, 33, "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
|
|
digest[0], digest[1], digest[2], digest[3], digest[4], digest[5], digest[6], digest[7],
|
|
digest[8], digest[9], digest[10], digest[11], digest[12], digest[13], digest[14], digest[15]
|
|
);
|
|
return std::string(hashStr);
|
|
}
|
|
|
|
// Consumes the blockDevice.
|
|
// If failed, returns an empty string, otherwise a 32-character string with the hash in hex format.
|
|
static std::string ComputePSPISOHash(std::shared_ptr<BlockDevice> blockDevice) {
|
|
md5_context md5;
|
|
ppsspp_md5_starts(&md5);
|
|
|
|
SequentialHandleAllocator alloc;
|
|
{
|
|
// ISOFileSystem takes owneship of the blockDevice here.
|
|
auto fs = std::make_unique<ISOFileSystem>(&alloc, blockDevice);
|
|
if (!HashISOFile(fs.get(), "PSP_GAME/PARAM.SFO", &md5)) {
|
|
return std::string();
|
|
}
|
|
if (!HashISOFile(fs.get(), "PSP_GAME/SYSDIR/EBOOT.BIN", &md5)) {
|
|
return std::string();
|
|
}
|
|
}
|
|
|
|
uint8_t digest[16];
|
|
ppsspp_md5_finish(&md5, digest);
|
|
return FormatRCheevosMD5(digest);
|
|
}
|
|
|
|
static std::string ComputePSPHomebrewHash(FileLoader *fileLoader) {
|
|
md5_context md5;
|
|
ppsspp_md5_starts(&md5);
|
|
|
|
// Cap the data we read to 64MB (MAX_BUFFER_SIZE in rcheevos' hash.c), and hash that.
|
|
std::vector<uint8_t> buffer;
|
|
size_t fileSize = std::min((s64)(1024 * 1024 * 64), fileLoader->FileSize());
|
|
buffer.resize(fileSize);
|
|
fileLoader->ReadAt(0, fileSize, buffer.data(), FileLoader::Flags::NONE);
|
|
ppsspp_md5_update(&md5, buffer.data(), (int)buffer.size());
|
|
|
|
uint8_t digest[16];
|
|
ppsspp_md5_finish(&md5, digest);
|
|
return FormatRCheevosMD5(digest);
|
|
}
|
|
|
|
static inline const char *DeNull(const char *ptr) {
|
|
return ptr ? ptr : "";
|
|
}
|
|
|
|
void OnAchievementsLoginStateChange() {
|
|
System_PostUIMessage(UIMessage::ACHIEVEMENT_LOGIN_STATE_CHANGE);
|
|
}
|
|
|
|
namespace Achievements {
|
|
|
|
// It's the name of the secret, not a secret name - the value is not secret :)
|
|
static const char * const RA_TOKEN_SECRET_NAME = "retroachievements";
|
|
|
|
static Achievements::Statistics g_stats;
|
|
|
|
const std::string g_gameIconCachePrefix = "game:";
|
|
const std::string g_iconCachePrefix = "badge:";
|
|
|
|
Path g_gamePath;
|
|
std::string s_game_hash;
|
|
|
|
std::set<uint32_t> g_activeChallenges;
|
|
bool g_isIdentifying = false;
|
|
bool g_isLoggingIn = false;
|
|
bool g_hasRichPresence = false;
|
|
int g_loginResult;
|
|
|
|
double g_lastLoginAttemptTime;
|
|
|
|
// rc_client implementation
|
|
static rc_client_t *g_rcClient;
|
|
static const std::string g_RAImageID = "I_RETROACHIEVEMENTS_LOGO";
|
|
constexpr double LOGIN_ATTEMPT_INTERVAL_S = 10.0;
|
|
|
|
#define PSP_MEMORY_OFFSET 0x08000000
|
|
|
|
static void TryLoginByToken(bool isInitialAttempt);
|
|
|
|
rc_client_t *GetClient() {
|
|
return g_rcClient;
|
|
}
|
|
|
|
bool IsLoggedIn() {
|
|
return rc_client_get_user_info(g_rcClient) != nullptr && !g_isLoggingIn;
|
|
}
|
|
|
|
// This is the RetroAchievements game ID, rather than the PSP game ID.
|
|
static u32 GetGameID() {
|
|
if (!g_rcClient) {
|
|
return 0;
|
|
}
|
|
|
|
const rc_client_game_t *info = rc_client_get_game_info(g_rcClient);
|
|
if (!info) {
|
|
return 0;
|
|
}
|
|
return info->id; // 0 if not identified
|
|
}
|
|
|
|
bool EncoreModeActive() {
|
|
if (!g_rcClient) {
|
|
return false;
|
|
}
|
|
return rc_client_get_encore_mode_enabled(g_rcClient);
|
|
}
|
|
|
|
bool UnofficialEnabled() {
|
|
if (!g_rcClient) {
|
|
return false;
|
|
}
|
|
return rc_client_get_unofficial_enabled(g_rcClient);
|
|
}
|
|
|
|
bool HardcoreModeActive() {
|
|
if (!g_rcClient) {
|
|
return false;
|
|
}
|
|
// See "Enabling Hardcore" under https://github.com/RetroAchievements/rcheevos/wiki/rc_client-integration.
|
|
return IsLoggedIn() && rc_client_get_hardcore_enabled(g_rcClient) && rc_client_is_processing_required(g_rcClient);
|
|
}
|
|
|
|
size_t GetRichPresenceMessage(char *buffer, size_t bufSize) {
|
|
if (!IsLoggedIn() || !rc_client_has_rich_presence(g_rcClient)) {
|
|
return (size_t)-1;
|
|
}
|
|
return rc_client_get_rich_presence_message(g_rcClient, buffer, bufSize);
|
|
}
|
|
|
|
bool WarnUserIfHardcoreModeActive(bool isSaveStateAction, std::string_view message) {
|
|
if (!HardcoreModeActive() || (isSaveStateAction && g_Config.bAchievementsSaveStateInHardcoreMode)) {
|
|
return false;
|
|
}
|
|
|
|
std::string_view showMessage = message;
|
|
if (message.empty()) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
showMessage = ac->T("This feature is not available in Hardcore Mode");
|
|
}
|
|
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, showMessage, "", g_RAImageID, 3.0f);
|
|
return true;
|
|
}
|
|
|
|
bool IsBlockingExecution() {
|
|
if (g_isLoggingIn || g_isIdentifying) {
|
|
// Useful for debugging race conditions.
|
|
// INFO_LOG(Log::Achievements, "isLoggingIn: %d isIdentifying: %d", (int)g_isLoggingIn, (int)g_isIdentifying);
|
|
}
|
|
return g_isLoggingIn || g_isIdentifying;
|
|
}
|
|
|
|
bool IsActive() {
|
|
return GetGameID() != 0;
|
|
}
|
|
|
|
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
|
|
static void raintegration_write_memory_handler(uint32_t address, uint8_t *buffer, uint32_t num_bytes, rc_client_t *client) {
|
|
// convert_retroachievements_address_to_real_address
|
|
const uint32_t realAddress = address + PSP_MEMORY_OFFSET;
|
|
if (!Memory::IsValidRange(realAddress, num_bytes)) {
|
|
ERROR_LOG(Log::Achievements, "RAIntegration write memory: Bad address range %08x-%08x (%d bytes) (%08x was passed in)", realAddress, realAddress + num_bytes, num_bytes, address);
|
|
return;
|
|
}
|
|
|
|
// We checked the pointer above, this is ok.
|
|
uint8_t *writePtr = Memory::GetPointerWriteUnchecked(realAddress);
|
|
memcpy(writePtr, buffer, num_bytes);
|
|
}
|
|
|
|
#endif
|
|
|
|
static uint32_t read_memory_callback(uint32_t address, uint8_t *buffer, uint32_t num_bytes, rc_client_t *client) {
|
|
// Achievements are traditionally defined relative to the base of main memory of the emulated console.
|
|
// This is some kind of RetroArch-related legacy. In the PSP's case, this is simply a straight offset of 0x08000000.
|
|
const uint32_t realAddress = address + PSP_MEMORY_OFFSET;
|
|
|
|
if (!Memory::IsValidRange(realAddress, num_bytes)) {
|
|
// Some achievement packs are really, really spammy.
|
|
// So we'll just count the bad accesses.
|
|
Achievements::g_stats.badMemoryAccessCount++;
|
|
if (g_Config.bAchievementsLogBadMemReads) {
|
|
WARN_LOG(Log::G3D, "RetroAchievements PeekMemory: Bad address %08x (%d bytes) (%08x was passed in)", realAddress, num_bytes, address);
|
|
}
|
|
// This tells rcheevos that the access was bad, which should now be handled properly.
|
|
return 0;
|
|
}
|
|
|
|
Memory::MemcpyUnchecked(buffer, realAddress, num_bytes);
|
|
return num_bytes;
|
|
}
|
|
|
|
// This is the HTTP request dispatcher that is provided to the rc_client. Whenever the client
|
|
// needs to talk to the server, it will call this function.
|
|
static void server_call_callback(const rc_api_request_t *request,
|
|
rc_client_server_callback_t callback, void *callback_data, rc_client_t *client)
|
|
{
|
|
// If post data is provided, we need to make a POST request, otherwise, a GET request will suffice.
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
std::string url = http::RemoveHttpsIfNeeded(request->url);
|
|
if (request->post_data) {
|
|
std::shared_ptr<http::Request> download = g_DownloadManager.AsyncPostWithCallback(url, std::string(request->post_data), "application/x-www-form-urlencoded", http::RequestFlags::ProgressBar | http::RequestFlags::ProgressBarDelayed,
|
|
[callback, callback_data](http::Request &download) {
|
|
std::string buffer;
|
|
download.buffer().TakeAll(&buffer);
|
|
rc_api_server_response_t response{};
|
|
response.body = buffer.c_str();
|
|
response.body_length = buffer.size();
|
|
response.http_status_code = download.ResultCode();
|
|
callback(&response, callback_data);
|
|
}, ac->T("Contacting RetroAchievements server..."));
|
|
} else {
|
|
std::shared_ptr<http::Request> download = g_DownloadManager.StartDownload(url, Path(), http::RequestFlags::ProgressBar | http::RequestFlags::ProgressBarDelayed, nullptr,
|
|
ac->T("Contacting RetroAchievements server..."),
|
|
[callback, callback_data](http::Request &download) {
|
|
std::string buffer;
|
|
download.buffer().TakeAll(&buffer);
|
|
rc_api_server_response_t response{};
|
|
response.body = buffer.c_str();
|
|
response.body_length = buffer.size();
|
|
response.http_status_code = download.ResultCode();
|
|
callback(&response, callback_data);
|
|
});
|
|
}
|
|
}
|
|
|
|
static void log_message_callback(const char *message, const rc_client_t *client) {
|
|
INFO_LOG(Log::Achievements, "RetroAchievements: %s", message);
|
|
}
|
|
|
|
// For detailed documentation, see https://github.com/RetroAchievements/rcheevos/wiki/rc_client_set_event_handler.
|
|
static void event_handler_callback(const rc_client_event_t *event, rc_client_t *client) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
|
|
switch (event->type) {
|
|
case RC_CLIENT_EVENT_ACHIEVEMENT_TRIGGERED:
|
|
// An achievement was earned by the player. The handler should notify the player that the achievement was earned.
|
|
g_OSD.ShowAchievementUnlocked(event->achievement->id);
|
|
System_PostUIMessage(UIMessage::REQUEST_PLAY_SOUND, "achievement_unlocked");
|
|
INFO_LOG(Log::Achievements, "Achievement unlocked: '%s' (%d)", event->achievement->title, event->achievement->id);
|
|
break;
|
|
|
|
case RC_CLIENT_EVENT_GAME_COMPLETED:
|
|
case RC_CLIENT_EVENT_SUBSET_COMPLETED:
|
|
{
|
|
// TODO: Do some zany fireworks!
|
|
|
|
// All achievements for the game have been earned. The handler should notify the player that the game was completed or mastered, depending on mode, hardcore or not.
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
|
|
const rc_client_game_t *gameInfo = rc_client_get_game_info(g_rcClient);
|
|
|
|
std::string setTitle = gameInfo->title;
|
|
std::string badgeUrl = gameInfo->badge_url;
|
|
if (event->type == RC_CLIENT_EVENT_SUBSET_COMPLETED) {
|
|
const rc_client_subset_t *subset = event->subset;
|
|
setTitle = subset->title;
|
|
badgeUrl = subset->badge_url;
|
|
}
|
|
|
|
DownloadImageIfMissing(badgeUrl);
|
|
|
|
std::string_view completedMessage = rc_client_get_hardcore_enabled(g_rcClient) ? "Mastered %1" : "Completed %1";
|
|
std::string title = ApplySafeSubstitutions(ac->T(completedMessage), setTitle);
|
|
|
|
rc_client_user_game_summary_t summary;
|
|
rc_client_get_user_game_summary(g_rcClient, &summary);
|
|
|
|
std::string message = ApplySafeSubstitutions(ac->T("%1 achievements, %2 points"), summary.num_unlocked_achievements, summary.points_unlocked);
|
|
|
|
// TODO: Make a fancier message for hardcore completed, etc.
|
|
// Also, differentiate subset vs game completed?
|
|
g_OSD.Show(OSDType::MESSAGE_INFO, title, message, badgeUrl, 10.0f);
|
|
|
|
System_PostUIMessage(UIMessage::REQUEST_PLAY_SOUND, "achievement_unlocked");
|
|
|
|
INFO_LOG(Log::Achievements, "%s", message.c_str());
|
|
break;
|
|
}
|
|
case RC_CLIENT_EVENT_LEADERBOARD_STARTED:
|
|
case RC_CLIENT_EVENT_LEADERBOARD_FAILED:
|
|
{
|
|
bool started = event->type == RC_CLIENT_EVENT_LEADERBOARD_STARTED;
|
|
// A leaderboard attempt has started. The handler may show a message with the leaderboard title and /or description indicating the attempt started.
|
|
const char *title = "";
|
|
const char *description = "";
|
|
// Hack around some problematic events in Burnout Legends. Hopefully this can be fixed in the backend.
|
|
if (strlen(event->leaderboard->title) > 0) {
|
|
title = event->leaderboard->title;
|
|
description = event->leaderboard->description;
|
|
} else {
|
|
title = event->leaderboard->description;
|
|
}
|
|
INFO_LOG(Log::Achievements, "Attempt %s: %s", started ? "started" : "failed", title);
|
|
g_OSD.ShowLeaderboardStartEnd(ApplySafeSubstitutions(ac->T(started ? "%1: Attempt started" : "%1: Attempt failed"), title), description, started);
|
|
break;
|
|
}
|
|
case RC_CLIENT_EVENT_LEADERBOARD_SUBMITTED:
|
|
{
|
|
INFO_LOG(Log::Achievements, "Leaderboard result submitted: %s", event->leaderboard->title);
|
|
// Actually showing the result when we get the scoreboard message and have the new rank.
|
|
break;
|
|
}
|
|
case RC_CLIENT_EVENT_LEADERBOARD_SCOREBOARD:
|
|
{
|
|
const char *title = event->leaderboard->title;
|
|
// Hack around some problematic events in Burnout Legends. Hopefully this can be fixed in the backend.
|
|
std::string msg;
|
|
const rc_client_leaderboard_scoreboard_t *scoreboard = event->leaderboard_scoreboard;
|
|
if (event->leaderboard_scoreboard) {
|
|
msg = ApplySafeSubstitutions(ac->T("Submitted %1 for %2"), DeNull(scoreboard->submitted_score), title);
|
|
if (!strcmp(scoreboard->best_score, scoreboard->submitted_score)) {
|
|
msg += ": ";
|
|
msg += ApplySafeSubstitutions(ac->T("Rank: %1"), scoreboard->new_rank);
|
|
} else {
|
|
msg += ": ";
|
|
msg += ApplySafeSubstitutions(ac->T("Best: %1"), scoreboard->best_score);
|
|
}
|
|
} else {
|
|
msg = ApplySafeSubstitutions(ac->T("Submitted %1 for %2"), DeNull(event->leaderboard->tracker_value), title);
|
|
}
|
|
g_OSD.ShowLeaderboardSubmitted(msg, "");
|
|
System_PostUIMessage(UIMessage::REQUEST_PLAY_SOUND, "leaderboard_submitted");
|
|
break;
|
|
}
|
|
case RC_CLIENT_EVENT_ACHIEVEMENT_CHALLENGE_INDICATOR_SHOW:
|
|
INFO_LOG(Log::Achievements, "Challenge indicator show: %s", event->achievement->title);
|
|
g_OSD.ShowChallengeIndicator(event->achievement->id, true);
|
|
g_activeChallenges.insert(event->achievement->id);
|
|
// A challenge achievement has become active. The handler should show a small version of the achievement icon
|
|
// to indicate the challenge is active.
|
|
break;
|
|
case RC_CLIENT_EVENT_ACHIEVEMENT_CHALLENGE_INDICATOR_HIDE:
|
|
INFO_LOG(Log::Achievements, "Challenge indicator hide: %s", event->achievement->title);
|
|
g_OSD.ShowChallengeIndicator(event->achievement->id, false);
|
|
g_activeChallenges.erase(event->achievement->id);
|
|
// The handler should hide the small version of the achievement icon that was shown by the corresponding RC_CLIENT_EVENT_ACHIEVEMENT_CHALLENGE_INDICATOR_SHOW event.
|
|
break;
|
|
case RC_CLIENT_EVENT_ACHIEVEMENT_PROGRESS_INDICATOR_SHOW:
|
|
INFO_LOG(Log::Achievements, "Progress indicator show: %s, progress: '%s' (%f)", event->achievement->title, event->achievement->measured_progress, event->achievement->measured_percent);
|
|
// An achievement that tracks progress has changed the amount of progress that has been made.
|
|
// The handler should show a small version of the achievement icon along with the achievement->measured_progress text (for two seconds).
|
|
// Only one progress indicator should be shown at a time.
|
|
// If a progress indicator is already visible, it should be updated with the new icon and text, and the two second timer should be restarted.
|
|
g_OSD.ShowAchievementProgress(event->achievement->id, true);
|
|
break;
|
|
case RC_CLIENT_EVENT_ACHIEVEMENT_PROGRESS_INDICATOR_UPDATE:
|
|
INFO_LOG(Log::Achievements, "Progress indicator update: %s, progress: '%s' (%f)", event->achievement->title, event->achievement->measured_progress, event->achievement->measured_percent);
|
|
g_OSD.ShowAchievementProgress(event->achievement->id, true);
|
|
break;
|
|
case RC_CLIENT_EVENT_ACHIEVEMENT_PROGRESS_INDICATOR_HIDE:
|
|
INFO_LOG(Log::Achievements, "Progress indicator hide");
|
|
// An achievement that tracks progress has changed the amount of progress that has been made.
|
|
// The handler should show a small version of the achievement icon along with the achievement->measured_progress text (for two seconds).
|
|
// Only one progress indicator should be shown at a time.
|
|
// If a progress indicator is already visible, it should be updated with the new icon and text, and the two second timer should be restarted.
|
|
g_OSD.ShowAchievementProgress(0, false);
|
|
break;
|
|
case RC_CLIENT_EVENT_LEADERBOARD_TRACKER_SHOW:
|
|
INFO_LOG(Log::Achievements, "Leaderboard tracker show: '%s' (id %d)", event->leaderboard_tracker->display, event->leaderboard_tracker->id);
|
|
// A leaderboard_tracker has become active. The handler should show the tracker text on screen.
|
|
// Multiple active leaderboards may share a single tracker if they have the same definition and value.
|
|
// As such, the leaderboard tracker IDs are unique amongst the leaderboard trackers, and have no correlation to the active leaderboard(s).
|
|
// Use event->leaderboard_tracker->id for uniqueness checks, and display event->leaderboard_tracker->display (string)
|
|
g_OSD.ShowLeaderboardTracker(event->leaderboard_tracker->id, event->leaderboard_tracker->display, true);
|
|
break;
|
|
case RC_CLIENT_EVENT_LEADERBOARD_TRACKER_HIDE:
|
|
// A leaderboard_tracker has become inactive. The handler should hide the tracker text from the screen.
|
|
INFO_LOG(Log::Achievements, "Leaderboard tracker hide: '%s' (id %d)", event->leaderboard_tracker->display, event->leaderboard_tracker->id);
|
|
g_OSD.ShowLeaderboardTracker(event->leaderboard_tracker->id, "", false);
|
|
break;
|
|
case RC_CLIENT_EVENT_LEADERBOARD_TRACKER_UPDATE:
|
|
// A leaderboard_tracker value has been updated. The handler should update the tracker text on the screen.
|
|
INFO_LOG(Log::Achievements, "Leaderboard tracker update: '%s' (id %d)", event->leaderboard_tracker->display, event->leaderboard_tracker->id);
|
|
g_OSD.ShowLeaderboardTracker(event->leaderboard_tracker->id, event->leaderboard_tracker->display, true);
|
|
break;
|
|
case RC_CLIENT_EVENT_RESET:
|
|
WARN_LOG(Log::Achievements, "Resetting game due to achievement setting change!");
|
|
// Hardcore mode was enabled, or something else that forces a game reset.
|
|
System_PostUIMessage(UIMessage::REQUEST_GAME_RESET);
|
|
break;
|
|
case RC_CLIENT_EVENT_SERVER_ERROR:
|
|
ERROR_LOG(Log::Achievements, "Server error: %s: %s", event->server_error->api, event->server_error->error_message);
|
|
g_OSD.Show(OSDType::MESSAGE_ERROR, "Server error", "", g_RAImageID);
|
|
break;
|
|
default:
|
|
WARN_LOG(Log::Achievements, "Unhandled rc_client event %d, ignoring", event->type);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void login_token_callback(int result, const char *error_message, rc_client_t *client, void *userdata) {
|
|
bool isInitialAttempt = userdata != nullptr;
|
|
switch (result) {
|
|
case RC_OK:
|
|
{
|
|
INFO_LOG(Log::Achievements, "Successful login by token.");
|
|
OnAchievementsLoginStateChange();
|
|
if (!isInitialAttempt) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
g_OSD.Show(OSDType::MESSAGE_SUCCESS, ac->T("Reconnected to RetroAchievements."), "", g_RAImageID);
|
|
}
|
|
break;
|
|
}
|
|
case RC_NO_RESPONSE:
|
|
{
|
|
if (isInitialAttempt) {
|
|
auto di = GetI18NCategory(I18NCat::DIALOG);
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, di->T("Failed to connect to server, check your internet connection."), "", g_RAImageID);
|
|
}
|
|
break;
|
|
}
|
|
case RC_ACCESS_DENIED:
|
|
case RC_INVALID_CREDENTIALS:
|
|
case RC_EXPIRED_TOKEN:
|
|
case RC_API_FAILURE:
|
|
case RC_INVALID_STATE:
|
|
case RC_MISSING_VALUE:
|
|
case RC_INVALID_JSON:
|
|
default:
|
|
{
|
|
ERROR_LOG(Log::Achievements, "Callback: Failure logging in via token: %d, %s", result, error_message);
|
|
if (isInitialAttempt) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
char message[512];
|
|
snprintf(message, sizeof(message), "%d: %s", result, error_message);
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, ac->T("Failed logging in to RetroAchievements"), message, g_RAImageID);
|
|
}
|
|
|
|
// Take some action.
|
|
switch (result) {
|
|
case RC_INVALID_CREDENTIALS:
|
|
g_loginResult = RC_OK; // why?
|
|
break;
|
|
case RC_EXPIRED_TOKEN:
|
|
WARN_LOG(Log::Achievements, "Clearing token since it was expired");
|
|
NativeClearSecret(RA_TOKEN_SECRET_NAME);
|
|
g_loginResult = RC_OK; // why?
|
|
break;
|
|
default:
|
|
g_loginResult = result;
|
|
break;
|
|
}
|
|
OnAchievementsLoginStateChange();
|
|
g_isLoggingIn = false;
|
|
return;
|
|
}
|
|
}
|
|
g_loginResult = result;
|
|
g_isLoggingIn = false;
|
|
}
|
|
|
|
bool RAIntegrationDirty() {
|
|
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
return rc_client_raintegration_has_modifications(g_rcClient);
|
|
#else
|
|
return false;
|
|
#endif
|
|
}
|
|
|
|
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
|
|
static void raintegration_get_game_name_handler(char *buffer, uint32_t buffer_size, rc_client_t *client) {
|
|
snprintf(buffer, buffer_size, "%s", g_gamePath.GetFilename().c_str());
|
|
}
|
|
|
|
static void raintegration_write_memory_handler(uint32_t address, uint8_t *buffer, uint32_t num_bytes, rc_client_t *client);
|
|
|
|
static void raintegration_event_handler(const rc_client_raintegration_event_t *event, rc_client_t *client) {
|
|
switch (event->type) {
|
|
case RC_CLIENT_RAINTEGRATION_EVENT_MENUITEM_CHECKED_CHANGED:
|
|
// The checked state of one of the menu items has changed and should be reflected in the UI.
|
|
// Call the handy helper function if the menu was created by rc_client_raintegration_rebuild_submenu.
|
|
System_RunCallbackInWndProc([](void *vhWnd, void *userdata) {
|
|
auto menuItem = reinterpret_cast<const rc_client_raintegration_menu_item_t *>(userdata);
|
|
rc_client_raintegration_update_menu_item(g_rcClient, menuItem);
|
|
}, reinterpret_cast<void *>(reinterpret_cast<int64_t>(event->menu_item)));
|
|
break;
|
|
case RC_CLIENT_RAINTEGRATION_EVENT_PAUSE:
|
|
// The toolkit has hit a breakpoint and wants to pause the emulator. Do so.
|
|
Core_Break(BreakReason::RABreak);
|
|
break;
|
|
case RC_CLIENT_RAINTEGRATION_EVENT_HARDCORE_CHANGED:
|
|
// Hardcore mode has been changed (either directly by the user, or disabled through the use of the tools).
|
|
// The frontend doesn't necessarily need to know that this value changed, they can still query it whenever
|
|
// it's appropriate, but the event lets the frontend do things like enable/disable rewind or cheats.
|
|
g_Config.bAchievementsHardcoreMode = rc_client_get_hardcore_enabled(client);
|
|
break;
|
|
case RC_CLIENT_RAINTEGRATION_EVENT_MENU_CHANGED:
|
|
System_RunCallbackInWndProc([](void *vhWnd, void *userdata) {
|
|
HWND hWnd = reinterpret_cast<HWND>(vhWnd);
|
|
rc_client_raintegration_rebuild_submenu(g_rcClient, GetMenu(hWnd));
|
|
}, nullptr);
|
|
break;
|
|
default:
|
|
ERROR_LOG(Log::Achievements, "Unsupported RAIntegration event %u\n", event->type);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void load_integration_callback(int result, const char *error_message, rc_client_t *client, void *userdata) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
|
|
// If DLL not present, do nothing. User can still play without the toolkit.
|
|
switch (result) {
|
|
case RC_OK:
|
|
{
|
|
// DLL was loaded correctly.
|
|
g_OSD.Show(OSDType::MESSAGE_SUCCESS, ApplySafeSubstitutions(ac->T("%1 loaded."), RAINTEGRATION_FILENAME));
|
|
|
|
rc_client_raintegration_set_console_id(g_rcClient, RC_CONSOLE_PSP);
|
|
rc_client_raintegration_set_event_handler(g_rcClient, &raintegration_event_handler);
|
|
rc_client_raintegration_set_write_memory_function(g_rcClient, &raintegration_write_memory_handler);
|
|
rc_client_raintegration_set_get_game_name_function(g_rcClient, &raintegration_get_game_name_handler);
|
|
|
|
System_RunCallbackInWndProc([](void *vhWnd, void *userdata) {
|
|
HWND hWnd = reinterpret_cast<HWND>(vhWnd);
|
|
rc_client_raintegration_rebuild_submenu(g_rcClient, GetMenu(hWnd));
|
|
}, nullptr);
|
|
break;
|
|
}
|
|
case RC_MISSING_VALUE:
|
|
// This is fine, proceeding to login.
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, ApplySafeSubstitutions(ac->T("RAIntegration is enabled, but %1 was not found."), RAINTEGRATION_FILENAME));
|
|
break;
|
|
case RC_ABORTED:
|
|
// This is fine(-ish), proceeding to login.
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, ApplySafeSubstitutions("Wrong version of %1?", RAINTEGRATION_FILENAME));
|
|
break;
|
|
default:
|
|
g_OSD.Show(OSDType::MESSAGE_ERROR, StringFromFormat("RAIntegration init failed: %s", error_message));
|
|
// Bailing.
|
|
return;
|
|
}
|
|
|
|
// Things are ready to load a game. If the DLL was initialized, calling rc_client_begin_load_game will be redirected
|
|
// through the DLL so the toolkit has access to the game data. Similarly, things like rc_create_leaderboard_list will
|
|
// be redirected through the DLL to reflect any local changes made by the user.
|
|
TryLoginByToken(true);
|
|
}
|
|
#endif
|
|
|
|
void Initialize() {
|
|
if (!g_Config.bAchievementsEnable) {
|
|
INFO_LOG(Log::Achievements, "Achievements are disabled, not initializing.");
|
|
if (g_rcClient) {
|
|
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
rc_client_unload_raintegration(g_rcClient);
|
|
#endif
|
|
rc_client_destroy(g_rcClient);
|
|
g_rcClient = nullptr;
|
|
}
|
|
return;
|
|
}
|
|
if (g_rcClient) {
|
|
INFO_LOG(Log::Achievements, "Achievements already initialized");
|
|
return;
|
|
}
|
|
|
|
g_rcClient = rc_client_create(read_memory_callback, server_call_callback);
|
|
if (!g_rcClient) {
|
|
// Shouldn't happen really.
|
|
return;
|
|
}
|
|
|
|
// Provide a logging function to simplify debugging
|
|
rc_client_enable_logging(g_rcClient, RC_CLIENT_LOG_LEVEL_VERBOSE, log_message_callback);
|
|
if (!g_Config.sAchievementsHost.empty()) {
|
|
// Custom host, only useful for debugging against non-prod RA environments.
|
|
rc_client_set_host(g_rcClient, g_Config.sAchievementsHost.c_str());
|
|
} else if (!System_GetPropertyBool(SYSPROP_SUPPORTS_HTTPS)) {
|
|
// Disable SSL if not supported by our platform implementation.
|
|
rc_client_set_host(g_rcClient, "http://retroachievements.org");
|
|
}
|
|
|
|
rc_client_set_event_handler(g_rcClient, event_handler_callback);
|
|
|
|
// Set initial settings properly. Hardcore mode is checked by RAIntegration.
|
|
rc_client_set_hardcore_enabled(g_rcClient, g_Config.bAchievementsHardcoreMode ? 1 : 0);
|
|
rc_client_set_encore_mode_enabled(g_rcClient, g_Config.bAchievementsEncoreMode ? 1 : 0);
|
|
rc_client_set_unofficial_enabled(g_rcClient, g_Config.bAchievementsUnofficial ? 1 : 0);
|
|
|
|
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
if (!g_Config.bAchievementsEnableRAIntegration) {
|
|
TryLoginByToken(true);
|
|
}
|
|
#else
|
|
TryLoginByToken(true);
|
|
#endif
|
|
}
|
|
|
|
void InitializeRAIntegration(void *windowHandle) {
|
|
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
if (g_rcClient && g_Config.bAchievementsEnableRAIntegration) {
|
|
wchar_t szFilePath[MAX_PATH];
|
|
GetModuleFileNameW(NULL, szFilePath, MAX_PATH);
|
|
for (int64_t i = wcslen(szFilePath) - 1; i > 0; i--) {
|
|
if (szFilePath[i] == '\\') {
|
|
szFilePath[i] = '\0';
|
|
break;
|
|
}
|
|
}
|
|
HWND hWnd = (HWND)windowHandle;
|
|
if (!hWnd) {
|
|
ERROR_LOG(Log::Achievements, "RAIntegration is enabled, but no main window handle was found.");
|
|
return;
|
|
}
|
|
rc_client_begin_load_raintegration(g_rcClient, szFilePath, hWnd, "PPSSPP", PPSSPP_GIT_VERSION, &load_integration_callback, hWnd);
|
|
return;
|
|
}
|
|
#endif
|
|
}
|
|
|
|
bool HasToken() {
|
|
return !NativeLoadSecret(RA_TOKEN_SECRET_NAME).empty();
|
|
}
|
|
|
|
bool LoginProblems(std::string *errorString) {
|
|
// TODO: Set error string.
|
|
return g_loginResult != RC_OK;
|
|
}
|
|
|
|
static void TryLoginByToken(bool isInitialAttempt) {
|
|
if (g_Config.sAchievementsUserName.empty()) {
|
|
// Don't even look for a token - without a username we can't login.
|
|
return;
|
|
}
|
|
std::string api_token = NativeLoadSecret(RA_TOKEN_SECRET_NAME);
|
|
if (!api_token.empty()) {
|
|
g_isLoggingIn = true;
|
|
rc_client_begin_login_with_token(g_rcClient, g_Config.sAchievementsUserName.c_str(), api_token.c_str(), &login_token_callback, (void *)isInitialAttempt);
|
|
}
|
|
}
|
|
|
|
static void login_password_callback(int result, const char *error_message, rc_client_t *client, void *userdata) {
|
|
auto di = GetI18NCategory(I18NCat::DIALOG);
|
|
switch (result) {
|
|
case RC_OK:
|
|
{
|
|
// Get the token and store it.
|
|
const rc_client_user_t *user = rc_client_get_user_info(client);
|
|
g_Config.sAchievementsUserName = user->username;
|
|
NativeSaveSecret(RA_TOKEN_SECRET_NAME, std::string(user->token));
|
|
OnAchievementsLoginStateChange();
|
|
g_OSD.Show(OSDType::MESSAGE_SUCCESS, di->T("Logged in!"), "", g_RAImageID);
|
|
break;
|
|
}
|
|
case RC_NO_RESPONSE:
|
|
{
|
|
auto di = GetI18NCategory(I18NCat::DIALOG);
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, di->T("Failed to connect to server, check your internet connection."), "", g_RAImageID);
|
|
break;
|
|
}
|
|
case RC_INVALID_STATE:
|
|
case RC_API_FAILURE:
|
|
case RC_MISSING_VALUE:
|
|
case RC_INVALID_JSON:
|
|
case RC_ACCESS_DENIED:
|
|
case RC_INVALID_CREDENTIALS:
|
|
case RC_EXPIRED_TOKEN:
|
|
default:
|
|
{
|
|
ERROR_LOG(Log::Achievements, "Failure logging in via password: %d, %s", result, error_message);
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, di->T("Failed to log in, check your username and password."), "", g_RAImageID);
|
|
OnAchievementsLoginStateChange();
|
|
break;
|
|
}
|
|
}
|
|
|
|
g_OSD.RemoveProgressBar("cheevos_async_login", true, 0.1f);
|
|
g_loginResult = RC_OK; // For these, we don't want the "permanence" of the login-by-token failure, this prevents LoginProblems from returning true.
|
|
g_isLoggingIn = false;
|
|
}
|
|
|
|
bool LoginAsync(const char *username, const char *password) {
|
|
auto di = GetI18NCategory(I18NCat::DIALOG);
|
|
if (IsLoggedIn() || std::strlen(username) == 0 || std::strlen(password) == 0)
|
|
return false;
|
|
|
|
g_OSD.SetProgressBar("cheevos_async_login", di->T("Logging in..."), 0, 0, 0, 0.0f);
|
|
|
|
g_isLoggingIn = true;
|
|
rc_client_begin_login_with_password(g_rcClient, username, password, &login_password_callback, nullptr);
|
|
return true;
|
|
}
|
|
|
|
void Logout() {
|
|
rc_client_logout(g_rcClient);
|
|
// remove secret from config
|
|
NativeClearSecret(RA_TOKEN_SECRET_NAME);
|
|
g_Config.Save("Achievements logout");
|
|
g_activeChallenges.clear();
|
|
g_loginResult = RC_OK; // Allow trying again
|
|
OnAchievementsLoginStateChange();
|
|
}
|
|
|
|
void UpdateSettings() {
|
|
if (g_rcClient && !g_Config.bAchievementsEnable) {
|
|
// we're done here
|
|
Shutdown();
|
|
return;
|
|
}
|
|
|
|
if (!g_rcClient && g_Config.bAchievementsEnable) {
|
|
// we just got enabled.
|
|
Initialize();
|
|
}
|
|
}
|
|
|
|
bool Shutdown() {
|
|
g_activeChallenges.clear();
|
|
if (g_rcClient) {
|
|
#ifdef RC_CLIENT_SUPPORTS_RAINTEGRATION
|
|
rc_client_unload_raintegration(g_rcClient);
|
|
#endif
|
|
rc_client_destroy(g_rcClient);
|
|
g_rcClient = nullptr;
|
|
INFO_LOG(Log::Achievements, "Achievements shut down.");
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void ResetRuntime() {
|
|
if (!g_rcClient)
|
|
return;
|
|
INFO_LOG(Log::Achievements, "Resetting rcheevos state...");
|
|
rc_client_reset(g_rcClient);
|
|
g_activeChallenges.clear();
|
|
}
|
|
|
|
void FrameUpdate() {
|
|
if (!g_rcClient)
|
|
return;
|
|
rc_client_do_frame(g_rcClient);
|
|
}
|
|
|
|
void Idle() {
|
|
rc_client_idle(g_rcClient);
|
|
|
|
double now = time_now_d();
|
|
|
|
// If failed to log in, occasionally try again while the user is at the menu.
|
|
// Do not try if if in-game, that could get confusing.
|
|
if (g_Config.bAchievementsEnable && GetUIState() == UISTATE_MENU && now > g_lastLoginAttemptTime + LOGIN_ATTEMPT_INTERVAL_S) {
|
|
g_lastLoginAttemptTime = now;
|
|
if (g_rcClient && IsLoggedIn()) {
|
|
return; // All good.
|
|
}
|
|
if (g_Config.sAchievementsUserName.empty() || g_isLoggingIn || !HasToken()) {
|
|
// Didn't try to login yet or is in the process of logging in. Also OK.
|
|
return;
|
|
}
|
|
|
|
// In this situation, there's a token, but we're not logged in. Probably disrupted internet connection
|
|
// during startup.
|
|
// Let's make an attempt.
|
|
INFO_LOG(Log::Achievements, "Retrying login..");
|
|
TryLoginByToken(false);
|
|
}
|
|
}
|
|
|
|
void DoState(PointerWrap &p) {
|
|
auto sw = p.Section("Achievements", 0, 1);
|
|
if (!sw) {
|
|
// Save state is missing the section.
|
|
// Reset the runtime.
|
|
if (HasAchievementsOrLeaderboards()) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, ac->T("Save state loaded without achievement data"), "", g_RAImageID, 5.0f, "");
|
|
}
|
|
rc_client_reset(g_rcClient);
|
|
return;
|
|
}
|
|
|
|
uint32_t data_size = 0;
|
|
|
|
if (!IsActive()) {
|
|
Do(p, data_size);
|
|
if (p.mode == PointerWrap::MODE_READ) {
|
|
WARN_LOG(Log::Achievements, "Save state contained achievement data, but achievements are not active. Ignore.");
|
|
}
|
|
p.SkipBytes(data_size);
|
|
return;
|
|
}
|
|
|
|
if (p.mode == PointerWrap::MODE_MEASURE || p.mode == PointerWrap::MODE_WRITE || p.mode == PointerWrap::MODE_VERIFY || p.mode == PointerWrap::MODE_NOOP) {
|
|
data_size = (uint32_t)(g_rcClient ? rc_client_progress_size(g_rcClient) : 0);
|
|
}
|
|
Do(p, data_size);
|
|
|
|
if (data_size > 0) {
|
|
uint8_t *buffer = new uint8_t[data_size];
|
|
switch (p.mode) {
|
|
case PointerWrap::MODE_NOOP:
|
|
case PointerWrap::MODE_MEASURE:
|
|
case PointerWrap::MODE_WRITE:
|
|
case PointerWrap::MODE_VERIFY:
|
|
{
|
|
int retval = rc_client_serialize_progress(g_rcClient, buffer);
|
|
if (retval != RC_OK) {
|
|
ERROR_LOG(Log::Achievements, "Error %d serializing achievement data. Ignoring.", retval);
|
|
}
|
|
break;
|
|
}
|
|
default:
|
|
break;
|
|
}
|
|
|
|
DoArray(p, buffer, data_size);
|
|
|
|
switch (p.mode) {
|
|
case PointerWrap::MODE_READ:
|
|
{
|
|
int retval = rc_client_deserialize_progress(g_rcClient, buffer);
|
|
if (retval != RC_OK) {
|
|
// TODO: What should we really do here?
|
|
ERROR_LOG(Log::Achievements, "Error %d deserializing achievement data. Ignoring.", retval);
|
|
}
|
|
break;
|
|
}
|
|
default:
|
|
break;
|
|
}
|
|
delete[] buffer;
|
|
} else {
|
|
if (IsActive()) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
g_OSD.Show(OSDType::MESSAGE_WARNING, ac->T("Save state loaded without achievement data"), "", g_RAImageID, 5.0f);
|
|
}
|
|
rc_client_reset(g_rcClient);
|
|
}
|
|
}
|
|
|
|
bool HasAchievementsOrLeaderboards() {
|
|
if (!g_rcClient) {
|
|
return false;
|
|
}
|
|
return IsActive();
|
|
}
|
|
|
|
void DownloadImageIfMissing(std::string_view url) {
|
|
// On Linux for example, we currently have no way of doing a HTTPS request.
|
|
if (g_iconCache.MarkPending(url)) {
|
|
INFO_LOG(Log::Achievements, "Downloading image: %.*s", STR_VIEW(url));
|
|
g_DownloadManager.StartDownload(url, Path(), http::RequestFlags::Default, nullptr, "", [](http::Request &download) {
|
|
if (download.ResultCode() != 200)
|
|
return;
|
|
std::string data;
|
|
download.buffer().TakeAll(&data);
|
|
g_iconCache.InsertIcon(download.url(), IconFormat::PNG, std::move(data));
|
|
});
|
|
}
|
|
}
|
|
|
|
Statistics GetStatistics() {
|
|
return g_stats;
|
|
}
|
|
|
|
std::string GetGameAchievementSummary(uint32_t subsetId) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
|
|
rc_client_user_game_summary_t summary;
|
|
|
|
if (subsetId) {
|
|
rc_client_get_user_subset_summary(g_rcClient, subsetId, &summary);
|
|
} else {
|
|
rc_client_get_user_game_summary(g_rcClient, &summary);
|
|
}
|
|
|
|
std::string summaryString;
|
|
if (summary.num_core_achievements + summary.num_unofficial_achievements == 0) {
|
|
summaryString = ac->T("This game has no achievements");
|
|
} else {
|
|
summaryString = ApplySafeSubstitutions(ac->T("Earned", "You have unlocked %1 of %2 achievements, earning %3 of %4 points"),
|
|
summary.num_unlocked_achievements, summary.num_core_achievements + summary.num_unofficial_achievements,
|
|
summary.points_unlocked, summary.points_core);
|
|
if (HardcoreModeActive()) {
|
|
summaryString.append("\n");
|
|
summaryString.append(ac->T("Hardcore Mode"));
|
|
}
|
|
if (EncoreModeActive()) {
|
|
summaryString.append("\n");
|
|
summaryString.append(ac->T("Encore Mode"));
|
|
}
|
|
if (UnofficialEnabled()) {
|
|
summaryString.append("\n");
|
|
summaryString.append(ac->T("Unofficial achievements"));
|
|
}
|
|
}
|
|
return summaryString;
|
|
}
|
|
|
|
// Can happen two ways.
|
|
void ShowNotLoggedInMessage() {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
g_OSD.Show(OSDType::MESSAGE_ERROR, ac->T("Failed to connect to RetroAchievements. Achievements will not unlock."), "", g_RAImageID, 6.0f);
|
|
}
|
|
|
|
void identify_and_load_callback(int result, const char *error_message, rc_client_t *client, void *userdata) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
|
|
NOTICE_LOG(Log::Achievements, "Load callback: %d (%s)", result, error_message);
|
|
|
|
switch (result) {
|
|
case RC_OK:
|
|
{
|
|
// Successful! Show a message that we're active.
|
|
const rc_client_game_t *gameInfo = rc_client_get_game_info(client);
|
|
|
|
std::string imageUrl = http::RemoveHttpsIfNeeded(gameInfo->badge_url);
|
|
DownloadImageIfMissing(imageUrl);
|
|
|
|
GameRegion region = DetectGameRegionFromID(g_paramSFO.GetDiscID());
|
|
auto ga = GetI18NCategory(I18NCat::GAME);
|
|
std::string_view regionStr = ga->T(GameRegionToString(region));
|
|
std::string title(gameInfo->title);
|
|
if (region <= GameRegion::HOMEBREW) {
|
|
title += " (";
|
|
title += regionStr;
|
|
title += ")";
|
|
}
|
|
// TODO: Detect current subset.
|
|
g_OSD.Show(OSDType::MESSAGE_INFO, title, GetGameAchievementSummary(0), imageUrl, 5.0f);
|
|
break;
|
|
}
|
|
case RC_NO_GAME_LOADED:
|
|
{
|
|
GameRegion region = DetectGameRegionFromID(g_paramSFO.GetDiscID());
|
|
auto ga = GetI18NCategory(I18NCat::GAME);
|
|
std::string_view regionStr = ga->T(GameRegionToString(region));
|
|
std::string title(g_paramSFO.GetValueString("TITLE"));
|
|
if (region <= GameRegion::HOMEBREW) {
|
|
title += " (";
|
|
title += regionStr;
|
|
title += ")";
|
|
}
|
|
// The current game does not support achievements.
|
|
g_OSD.Show(OSDType::MESSAGE_INFO, title, ac->T("RetroAchievements are not available for this game"), g_RAImageID, 3.0f);
|
|
break;
|
|
}
|
|
case RC_NO_RESPONSE:
|
|
// We lost the internet connection at some point and can't report achievements.
|
|
ShowNotLoggedInMessage();
|
|
break;
|
|
default:
|
|
// Other various errors.
|
|
ERROR_LOG(Log::Achievements, "Failed to identify/load game: %d (%s)", result, error_message);
|
|
g_OSD.Show(OSDType::MESSAGE_ERROR, ac->T("Failed to identify game. Achievements will not unlock."), "", g_RAImageID, 6.0f);
|
|
break;
|
|
}
|
|
|
|
g_isIdentifying = false;
|
|
}
|
|
|
|
void SetGame(const Path &path, IdentifiedFileType fileType, FileLoader *fileLoader) {
|
|
bool homebrew = false;
|
|
switch (fileType) {
|
|
case IdentifiedFileType::PSP_ISO:
|
|
case IdentifiedFileType::PSP_ISO_NP:
|
|
// These file types are OK.
|
|
break;
|
|
case IdentifiedFileType::PSP_PBP_DIRECTORY:
|
|
// This should be a homebrew, which we now support as well.
|
|
// We select the homebrew hashing method.
|
|
homebrew = true;
|
|
break;
|
|
default:
|
|
// Other file types are not yet supported.
|
|
// TODO: Should we show an OSD popup here?
|
|
WARN_LOG(Log::Achievements, "File type of '%s' is not yet compatible with RetroAchievements", path.c_str());
|
|
return;
|
|
}
|
|
|
|
if (g_isLoggingIn) {
|
|
// IsReadyToStart should have been checked the same frame, so we shouldn't be here.
|
|
// Maybe there's a race condition possible, but don't think so.
|
|
ERROR_LOG(Log::Achievements, "Still logging in during SetGame - shouldn't happen");
|
|
}
|
|
|
|
if (!g_rcClient || !IsLoggedIn()) {
|
|
if (g_Config.bAchievementsEnable && HasToken()) {
|
|
ShowNotLoggedInMessage();
|
|
}
|
|
// Nothing to do.
|
|
return;
|
|
}
|
|
|
|
if (!fileLoader) {
|
|
ERROR_LOG(Log::Achievements, "File loader not initialized");
|
|
return;
|
|
}
|
|
|
|
// The caller should hold off on executing game code until this turns false, checking with IsBlockingExecution()
|
|
g_gamePath = path;
|
|
g_isIdentifying = true;
|
|
|
|
if (homebrew) {
|
|
// Homebrew hashing method - just hash the eboot.
|
|
s_game_hash = ComputePSPHomebrewHash(fileLoader);
|
|
} else {
|
|
// ISO hashing method.
|
|
//
|
|
// TODO: Fish the block device out of the loading process somewhere else. Though, probably easier to just do it here,
|
|
// we need a temporary blockdevice anyway since it gets consumed by ComputePSPISOHash.
|
|
std::string errorString;
|
|
std::shared_ptr<BlockDevice> blockDevice(ConstructBlockDevice(fileLoader, &errorString));
|
|
if (!blockDevice) {
|
|
ERROR_LOG(Log::Achievements, "Failed to construct block device for '%s' - can't identify: %s", path.c_str(), errorString.c_str());
|
|
g_isIdentifying = false;
|
|
return;
|
|
}
|
|
|
|
// This consumes the blockDevice.
|
|
s_game_hash = ComputePSPISOHash(blockDevice);
|
|
if (!s_game_hash.empty()) {
|
|
INFO_LOG(Log::Achievements, "Hash: %s", s_game_hash.c_str());
|
|
}
|
|
}
|
|
|
|
// Apply pre-load settings.
|
|
rc_client_set_hardcore_enabled(g_rcClient, g_Config.bAchievementsHardcoreMode ? 1 : 0);
|
|
rc_client_set_encore_mode_enabled(g_rcClient, g_Config.bAchievementsEncoreMode ? 1 : 0);
|
|
rc_client_set_unofficial_enabled(g_rcClient, g_Config.bAchievementsUnofficial ? 1 : 0);
|
|
|
|
rc_client_begin_load_game(g_rcClient, s_game_hash.c_str(), &identify_and_load_callback, nullptr);
|
|
}
|
|
|
|
void UnloadGame() {
|
|
if (g_rcClient) {
|
|
rc_client_unload_game(g_rcClient);
|
|
g_gamePath.clear();
|
|
s_game_hash.clear();
|
|
}
|
|
}
|
|
|
|
void change_media_callback(int result, const char *error_message, rc_client_t *client, void *userdata) {
|
|
auto ac = GetI18NCategory(I18NCat::ACHIEVEMENTS);
|
|
NOTICE_LOG(Log::Achievements, "Change media callback: %d (%s)", result, error_message);
|
|
g_isIdentifying = false;
|
|
|
|
switch (result) {
|
|
case RC_OK:
|
|
{
|
|
// Successful! Later, show a message that we succeeded.
|
|
break;
|
|
}
|
|
case RC_NO_GAME_LOADED:
|
|
// The current game does not support achievements.
|
|
g_OSD.Show(OSDType::MESSAGE_INFO, ac->T("RetroAchievements are not available for this game"), "", g_RAImageID, 3.0f);
|
|
break;
|
|
case RC_NO_RESPONSE:
|
|
// We lost the internet connection at some point and can't report achievements.
|
|
ShowNotLoggedInMessage();
|
|
break;
|
|
default:
|
|
// Other various errors.
|
|
ERROR_LOG(Log::Achievements, "Failed to identify/load game: %d (%s)", result, error_message);
|
|
g_OSD.Show(OSDType::MESSAGE_ERROR, ac->T("Failed to identify game. Achievements will not unlock."), "", g_RAImageID, 6.0f);
|
|
break;
|
|
}
|
|
}
|
|
|
|
void ChangeUMD(const Path &path, FileLoader *fileLoader) {
|
|
if (!IsActive()) {
|
|
// Nothing to do.
|
|
return;
|
|
}
|
|
|
|
std::string errorString;
|
|
std::shared_ptr<BlockDevice> blockDevice(ConstructBlockDevice(fileLoader, &errorString));
|
|
if (!blockDevice) {
|
|
ERROR_LOG(Log::Achievements, "Failed to construct block device for '%s' - can't identify: %s", path.c_str(), errorString.c_str());
|
|
return;
|
|
}
|
|
|
|
g_isIdentifying = true;
|
|
|
|
// This consumes the blockDevice.
|
|
s_game_hash = ComputePSPISOHash(blockDevice);
|
|
if (s_game_hash.empty()) {
|
|
ERROR_LOG(Log::Achievements, "Failed to hash - can't identify");
|
|
// Leaving this set makes IsBlockingExecution() true forever, so EmuScreen stops running
|
|
// the CPU and the game is frozen until restart. SetGame's equivalent path clears it too.
|
|
g_isIdentifying = false;
|
|
return;
|
|
}
|
|
|
|
rc_client_begin_change_media_from_hash(g_rcClient,
|
|
s_game_hash.c_str(),
|
|
&change_media_callback,
|
|
nullptr
|
|
);
|
|
}
|
|
|
|
std::set<uint32_t> GetActiveChallengeIDs() {
|
|
return g_activeChallenges;
|
|
}
|
|
|
|
} // namespace Achievements
|