/** * @file pfile.cpp * * Implementation of the save game encoding functionality. */ #include "pfile.h" #include #include "codec.h" #include "engine.h" #include "init.h" #include "loadsave.h" #include "mainmenu.h" #include "mpqapi.h" #include "pack.h" #include "storm/storm.h" #include "utils/endian.hpp" #include "utils/file_util.h" #include "utils/language.h" #include "utils/paths.h" namespace devilution { #define PASSWORD_SPAWN_SINGLE "adslhfb1" #define PASSWORD_SPAWN_MULTI "lshbkfg1" #define PASSWORD_SINGLE "xrgyrkj1" #define PASSWORD_MULTI "szqnlsk1" bool gbValidSaveFile; namespace { /** List of character names for the character selection screen. */ char hero_names[MAX_CHARACTERS][PLR_NAME_LEN]; std::string GetSavePath(uint32_t saveNum) { std::string path = paths::PrefPath(); const char *ext = ".sv"; if (gbIsHellfire) ext = ".hsv"; if (gbIsSpawn) { if (!gbIsMultiplayer) { path.append("spawn_"); } else { path.append("share_"); } } else { if (!gbIsMultiplayer) { path.append("single_"); } else { path.append("multi_"); } } char saveNumStr[21]; snprintf(saveNumStr, sizeof(saveNumStr) / sizeof(char), "%i", saveNum); path.append(saveNumStr); path.append(ext); return path; } bool GetPermSaveNames(uint8_t dwIndex, char *szPerm) { const char *fmt; if (dwIndex < giNumberOfLevels) fmt = "perml%02d"; else if (dwIndex < giNumberOfLevels * 2) { dwIndex -= giNumberOfLevels; fmt = "perms%02d"; } else return false; sprintf(szPerm, fmt, dwIndex); return true; } bool GetTempSaveNames(uint8_t dwIndex, char *szTemp) { const char *fmt; if (dwIndex < giNumberOfLevels) fmt = "templ%02d"; else if (dwIndex < giNumberOfLevels * 2) { dwIndex -= giNumberOfLevels; fmt = "temps%02d"; } else return false; sprintf(szTemp, fmt, dwIndex); return true; } void RenameTempToPerm() { char szTemp[MAX_PATH]; char szPerm[MAX_PATH]; uint32_t dwIndex = 0; while (GetTempSaveNames(dwIndex, szTemp)) { [[maybe_unused]] bool result = GetPermSaveNames(dwIndex, szPerm); // DO NOT PUT DIRECTLY INTO ASSERT! assert(result); dwIndex++; if (mpqapi_has_file(szTemp)) { if (mpqapi_has_file(szPerm)) mpqapi_remove_hash_entry(szPerm); mpqapi_rename(szTemp, szPerm); } } assert(!GetPermSaveNames(dwIndex, szPerm)); } uint32_t GetSaveNumberFromName(const char *name) { uint32_t i; for (i = 0; i < MAX_CHARACTERS; i++) { if (strcasecmp(hero_names[i], name) == 0) break; } return i; } std::unique_ptr ReadArchive(HANDLE archive, const char *pszName, size_t *pdwLen = nullptr) { HANDLE file; if (!SFileOpenFileEx(archive, pszName, 0, &file)) return nullptr; size_t length = SFileGetFileSize(file); if (length == 0) return nullptr; std::unique_ptr buf { new byte[length] }; if (!SFileReadFileThreadSafe(file, buf.get(), length)) return nullptr; SFileCloseFileThreadSafe(file); length = codec_decode(buf.get(), length, pfile_get_password()); if (length == 0) return nullptr; if (pdwLen != nullptr) *pdwLen = length; return buf; } bool ReadHero(HANDLE archive, PkPlayerStruct *pPack) { size_t read; auto buf = ReadArchive(archive, "hero", &read); if (buf == nullptr) return false; bool ret = false; if (read == sizeof(*pPack)) { memcpy(pPack, buf.get(), sizeof(*pPack)); ret = true; } return ret; } void EncodeHero(const PkPlayerStruct *pack) { size_t packedLen = codec_get_encoded_len(sizeof(*pack)); std::unique_ptr packed { new byte[packedLen] }; memcpy(packed.get(), pack, sizeof(*pack)); codec_encode(packed.get(), sizeof(*pack), packedLen, pfile_get_password()); mpqapi_write_file("hero", packed.get(), packedLen); } bool OpenArchive(uint32_t saveNum) { return OpenMPQ(GetSavePath(saveNum).c_str()); } HANDLE OpenSaveArchive(uint32_t saveNum) { HANDLE archive; if (SFileOpenArchive(GetSavePath(saveNum).c_str(), 0, 0, &archive)) return archive; return nullptr; } void CloseArchive(HANDLE *hsArchive) { if (*hsArchive == nullptr) return; SFileCloseArchive(*hsArchive); *hsArchive = nullptr; } void Game2UiPlayer(const PlayerStruct &player, _uiheroinfo *heroinfo, bool bHasSaveFile) { memset(heroinfo, 0, sizeof(*heroinfo)); strncpy(heroinfo->name, player._pName, sizeof(heroinfo->name) - 1); heroinfo->name[sizeof(heroinfo->name) - 1] = '\0'; heroinfo->level = player._pLevel; heroinfo->heroclass = player._pClass; heroinfo->strength = player._pStrength; heroinfo->magic = player._pMagic; heroinfo->dexterity = player._pDexterity; heroinfo->vitality = player._pVitality; heroinfo->hassaved = bHasSaveFile; heroinfo->herorank = player.pDiabloKillLevel; heroinfo->spawned = gbIsSpawn; } bool GetFileName(uint8_t lvl, char *dst) { const char *fmt; if (gbIsMultiplayer) { if (lvl != 0) return false; fmt = "hero"; } else { if (lvl < giNumberOfLevels) fmt = "perml%02d"; else if (lvl < giNumberOfLevels * 2) { lvl -= giNumberOfLevels; fmt = "perms%02d"; } else if (lvl == giNumberOfLevels * 2) fmt = "game"; else if (lvl == giNumberOfLevels * 2 + 1) fmt = "hero"; else return false; } sprintf(dst, fmt, lvl); return true; } bool ArchiveContainsGame(HANDLE hsArchive) { if (gbIsMultiplayer) return false; auto gameData = ReadArchive(hsArchive, "game"); if (gameData == nullptr) return false; uint32_t hdr = LoadLE32(gameData.get()); return IsHeaderValid(hdr); } } // namespace const char *pfile_get_password() { if (gbIsSpawn) return gbIsMultiplayer ? PASSWORD_SPAWN_MULTI : PASSWORD_SPAWN_SINGLE; return gbIsMultiplayer ? PASSWORD_MULTI : PASSWORD_SINGLE; } PFileScopedArchiveWriter::PFileScopedArchiveWriter(bool clearTables) : save_num_(GetSaveNumberFromName(Players[MyPlayerId]._pName)) , clear_tables_(clearTables) { if (!OpenArchive(save_num_)) app_fatal("%s", _("Failed to open player archive for writing.")); } PFileScopedArchiveWriter::~PFileScopedArchiveWriter() { mpqapi_flush_and_close(clear_tables_); } void pfile_write_hero(bool writeGameData, bool clearTables) { PFileScopedArchiveWriter scopedWriter(clearTables); if (writeGameData) { SaveGameData(); RenameTempToPerm(); } PkPlayerStruct pkplr; PackPlayer(&pkplr, Players[MyPlayerId], !gbIsMultiplayer); EncodeHero(&pkplr); if (!gbVanilla) { SaveHotkeys(); SaveHeroItems(Players[MyPlayerId]); } } bool pfile_ui_set_hero_infos(bool (*uiAddHeroInfo)(_uiheroinfo *)) { memset(hero_names, 0, sizeof(hero_names)); for (uint32_t i = 0; i < MAX_CHARACTERS; i++) { HANDLE archive = OpenSaveArchive(i); if (archive != nullptr) { PkPlayerStruct pkplr; if (ReadHero(archive, &pkplr)) { _uiheroinfo uihero; strcpy(hero_names[i], pkplr.pName); bool hasSaveGame = ArchiveContainsGame(archive); if (hasSaveGame) pkplr.bIsHellfire = gbIsHellfireSaveGame ? 1 : 0; UnPackPlayer(&pkplr, 0, false); CloseArchive(&archive); LoadHeroItems(Players[0]); RemoveEmptyInventory(Players[0]); CalcPlrInv(0, false); Game2UiPlayer(Players[0], &uihero, hasSaveGame); uiAddHeroInfo(&uihero); } CloseArchive(&archive); } } return true; } void pfile_ui_set_class_stats(unsigned int playerClass, _uidefaultstats *classStats) { classStats->strength = StrengthTbl[playerClass]; classStats->magic = MagicTbl[playerClass]; classStats->dexterity = DexterityTbl[playerClass]; classStats->vitality = VitalityTbl[playerClass]; } bool pfile_ui_save_create(_uiheroinfo *heroinfo) { PkPlayerStruct pkplr; uint32_t saveNum = GetSaveNumberFromName(heroinfo->name); if (saveNum >= MAX_CHARACTERS) { for (saveNum = 0; saveNum < MAX_CHARACTERS; saveNum++) { if (hero_names[saveNum][0] == '\0') break; } if (saveNum >= MAX_CHARACTERS) return false; } if (!OpenArchive(saveNum)) return false; mpqapi_remove_hash_entries(GetFileName); strncpy(hero_names[saveNum], heroinfo->name, PLR_NAME_LEN); hero_names[saveNum][PLR_NAME_LEN - 1] = '\0'; auto &player = Players[0]; CreatePlayer(0, heroinfo->heroclass); strncpy(player._pName, heroinfo->name, PLR_NAME_LEN); player._pName[PLR_NAME_LEN - 1] = '\0'; PackPlayer(&pkplr, player, true); EncodeHero(&pkplr); Game2UiPlayer(player, heroinfo, false); if (!gbVanilla) { SaveHotkeys(); SaveHeroItems(player); } mpqapi_flush_and_close(true); return true; } bool pfile_delete_save(_uiheroinfo *heroInfo) { uint32_t saveNum = GetSaveNumberFromName(heroInfo->name); if (saveNum < MAX_CHARACTERS) { hero_names[saveNum][0] = '\0'; RemoveFile(GetSavePath(saveNum).c_str()); } return true; } void pfile_read_player_from_save(char name[16], int playerId) { HANDLE archive; PkPlayerStruct pkplr; uint32_t saveNum = GetSaveNumberFromName(name); archive = OpenSaveArchive(saveNum); if (archive == nullptr) app_fatal("%s", _("Unable to open archive")); if (!ReadHero(archive, &pkplr)) app_fatal("%s", _("Unable to load character")); gbValidSaveFile = ArchiveContainsGame(archive); if (gbValidSaveFile) pkplr.bIsHellfire = gbIsHellfireSaveGame ? 1 : 0; CloseArchive(&archive); UnPackPlayer(&pkplr, playerId, false); LoadHeroItems(Players[playerId]); RemoveEmptyInventory(Players[playerId]); CalcPlrInv(playerId, false); } bool LevelFileExists() { char szName[MAX_PATH]; GetPermLevelNames(szName); uint32_t saveNum = GetSaveNumberFromName(Players[MyPlayerId]._pName); if (!OpenArchive(saveNum)) app_fatal("%s", _("Unable to read to save file archive")); bool hasFile = mpqapi_has_file(szName); mpqapi_flush_and_close(true); return hasFile; } void GetTempLevelNames(char *szTemp) { if (setlevel) sprintf(szTemp, "temps%02d", setlvlnum); else sprintf(szTemp, "templ%02d", currlevel); } void GetPermLevelNames(char *szPerm) { uint32_t saveNum = GetSaveNumberFromName(Players[MyPlayerId]._pName); GetTempLevelNames(szPerm); if (!OpenArchive(saveNum)) app_fatal("%s", _("Unable to read to save file archive")); bool hasFile = mpqapi_has_file(szPerm); mpqapi_flush_and_close(true); if (!hasFile) { if (setlevel) sprintf(szPerm, "perms%02d", setlvlnum); else sprintf(szPerm, "perml%02d", currlevel); } } void pfile_remove_temp_files() { if (gbIsMultiplayer) return; uint32_t saveNum = GetSaveNumberFromName(Players[MyPlayerId]._pName); if (!OpenArchive(saveNum)) app_fatal("%s", _("Unable to write to save file archive")); mpqapi_remove_hash_entries(GetTempSaveNames); mpqapi_flush_and_close(true); } std::unique_ptr pfile_read(const char *pszName, size_t *pdwLen) { HANDLE archive; uint32_t saveNum = GetSaveNumberFromName(Players[MyPlayerId]._pName); archive = OpenSaveArchive(saveNum); if (archive == nullptr) return nullptr; auto buf = ReadArchive(archive, pszName, pdwLen); CloseArchive(&archive); if (buf == nullptr) return nullptr; return buf; } void pfile_update(bool forceSave) { static Uint32 prevTick; if (!gbIsMultiplayer) return; Uint32 tick = SDL_GetTicks(); if (!forceSave && tick - prevTick <= 60000) return; prevTick = tick; pfile_write_hero(); } } // namespace devilution