Skip to content

Commit 80a6455

Browse files
DarioSamoDarioSamo
committed
Add CLI installation check option.
1 parent 7f9ce50 commit 80a6455

File tree

4 files changed

+238
-32
lines changed

4 files changed

+238
-32
lines changed

‎UnleashedRecomp/install/installer.cpp

Lines changed: 162 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,73 @@ static std::unique_ptr<VirtualFileSystem> createFileSystemFromPath(const std::fi
6767
}
6868
}
6969

70+
static bool checkFile(const FilePair &pair, const uint64_t *fileHashes, const std::filesystem::path &targetDirectory, std::vector<uint8_t> &fileData, Journal &journal, const std::function<bool()> &progressCallback, bool checkSizeOnly) {
71+
const std::string fileName(pair.first);
72+
const uint32_t hashCount = pair.second;
73+
const std::filesystem::path filePath = targetDirectory / fileName;
74+
if (!std::filesystem::exists(filePath))
75+
{
76+
journal.lastResult = Journal::Result::FileMissing;
77+
journal.lastErrorMessage = fmt::format("File {} does not exist.", fileName);
78+
return false;
79+
}
80+
81+
std::error_code ec;
82+
size_t fileSize = std::filesystem::file_size(filePath, ec);
83+
if (ec)
84+
{
85+
journal.lastResult = Journal::Result::FileReadFailed;
86+
journal.lastErrorMessage = fmt::format("Failed to read file size for {}.", fileName);
87+
return false;
88+
}
89+
90+
if (checkSizeOnly)
91+
{
92+
journal.progressTotal += fileSize;
93+
}
94+
else
95+
{
96+
std::ifstream fileStream(filePath, std::ios::binary);
97+
if (fileStream.is_open())
98+
{
99+
fileData.resize(fileSize);
100+
fileStream.read((char *)(fileData.data()), fileSize);
101+
}
102+
103+
if (!fileStream.is_open() || fileStream.bad())
104+
{
105+
journal.lastResult = Journal::Result::FileReadFailed;
106+
journal.lastErrorMessage = fmt::format("Failed to read file {}.", fileName);
107+
return false;
108+
}
109+
110+
uint64_t fileHash = XXH3_64bits(fileData.data(), fileSize);
111+
bool fileHashFound = false;
112+
for (uint32_t i = 0; i < hashCount && !fileHashFound; i++)
113+
{
114+
fileHashFound = fileHash == fileHashes[i];
115+
}
116+
117+
if (!fileHashFound)
118+
{
119+
journal.lastResult = Journal::Result::FileHashFailed;
120+
journal.lastErrorMessage = fmt::format("File {} did not match any of the known hashes.", fileName);
121+
return false;
122+
}
123+
124+
journal.progressCounter += fileSize;
125+
}
126+
127+
if (!progressCallback())
128+
{
129+
journal.lastResult = Journal::Result::Cancelled;
130+
journal.lastErrorMessage = "Check was cancelled.";
131+
return false;
132+
}
133+
134+
return true;
135+
}
136+
70137
static bool copyFile(const FilePair &pair, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, const std::filesystem::path &targetDirectory, bool skipHashChecks, std::vector<uint8_t> &fileData, Journal &journal, const std::function<bool()> &progressCallback) {
71138
const std::string filename(pair.first);
72139
const uint32_t hashCount = pair.second;
@@ -204,6 +271,45 @@ static DLC detectDLC(const std::filesystem::path &sourcePath, VirtualFileSystem
204271
}
205272
}
206273

274+
static bool fillDLCSource(DLC dlc, Installer::DLCSource &dlcSource)
275+
{
276+
switch (dlc)
277+
{
278+
case DLC::Spagonia:
279+
dlcSource.filePairs = { SpagoniaFiles, SpagoniaFilesSize };
280+
dlcSource.fileHashes = SpagoniaHashes;
281+
dlcSource.targetSubDirectory = SpagoniaDirectory;
282+
return true;
283+
case DLC::Chunnan:
284+
dlcSource.filePairs = { ChunnanFiles, ChunnanFilesSize };
285+
dlcSource.fileHashes = ChunnanHashes;
286+
dlcSource.targetSubDirectory = ChunnanDirectory;
287+
return true;
288+
case DLC::Mazuri:
289+
dlcSource.filePairs = { MazuriFiles, MazuriFilesSize };
290+
dlcSource.fileHashes = MazuriHashes;
291+
dlcSource.targetSubDirectory = MazuriDirectory;
292+
return true;
293+
case DLC::Holoska:
294+
dlcSource.filePairs = { HoloskaFiles, HoloskaFilesSize };
295+
dlcSource.fileHashes = HoloskaHashes;
296+
dlcSource.targetSubDirectory = HoloskaDirectory;
297+
return true;
298+
case DLC::ApotosShamar:
299+
dlcSource.filePairs = { ApotosShamarFiles, ApotosShamarFilesSize };
300+
dlcSource.fileHashes = ApotosShamarHashes;
301+
dlcSource.targetSubDirectory = ApotosShamarDirectory;
302+
return true;
303+
case DLC::EmpireCityAdabat:
304+
dlcSource.filePairs = { EmpireCityAdabatFiles, EmpireCityAdabatFilesSize };
305+
dlcSource.fileHashes = EmpireCityAdabatHashes;
306+
dlcSource.targetSubDirectory = EmpireCityAdabatDirectory;
307+
return true;
308+
default:
309+
return false;
310+
}
311+
}
312+
207313
bool Installer::checkGameInstall(const std::filesystem::path &baseDirectory, std::filesystem::path &modulePath)
208314
{
209315
modulePath = baseDirectory / PatchedDirectory / GameExecutableFile;
@@ -254,6 +360,40 @@ bool Installer::checkAllDLC(const std::filesystem::path& baseDirectory)
254360
return result;
255361
}
256362

363+
bool Installer::checkInstallIntegrity(const std::filesystem::path &baseDirectory, Journal &journal, const std::function<bool()> &progressCallback)
364+
{
365+
// Run the file checks twice: once to fill out the progress counter and the file sizes, and another pass to do the hash integrity checks.
366+
for (uint32_t checkPass = 0; checkPass < 2; checkPass++)
367+
{
368+
bool checkSizeOnly = (checkPass == 0);
369+
if (!checkFiles({ GameFiles, GameFilesSize }, GameHashes, baseDirectory / GameDirectory, journal, progressCallback, checkSizeOnly))
370+
{
371+
return false;
372+
}
373+
374+
if (!checkFiles({ UpdateFiles, UpdateFilesSize }, UpdateHashes, baseDirectory / UpdateDirectory, journal, progressCallback, checkSizeOnly))
375+
{
376+
return false;
377+
}
378+
379+
for (int i = 1; i < (int)DLC::Count; i++)
380+
{
381+
if (checkDLCInstall(baseDirectory, (DLC)i))
382+
{
383+
Installer::DLCSource dlcSource;
384+
fillDLCSource((DLC)i, dlcSource);
385+
386+
if (!checkFiles(dlcSource.filePairs, dlcSource.fileHashes, baseDirectory / dlcSource.targetSubDirectory, journal, progressCallback, checkSizeOnly))
387+
{
388+
return false;
389+
}
390+
}
391+
}
392+
}
393+
394+
return true;
395+
}
396+
257397
bool Installer::computeTotalSize(std::span<const FilePair> filePairs, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, Journal &journal, uint64_t &totalSize)
258398
{
259399
for (FilePair pair : filePairs)
@@ -272,6 +412,27 @@ bool Installer::computeTotalSize(std::span<const FilePair> filePairs, const uint
272412
return true;
273413
}
274414

415+
bool Installer::checkFiles(std::span<const FilePair> filePairs, const uint64_t *fileHashes, const std::filesystem::path &targetDirectory, Journal &journal, const std::function<bool()> &progressCallback, bool checkSizeOnly)
416+
{
417+
FilePair validationPair = {};
418+
uint32_t validationHashIndex = 0;
419+
uint32_t hashIndex = 0;
420+
uint32_t hashCount = 0;
421+
std::vector<uint8_t> fileData;
422+
for (FilePair pair : filePairs)
423+
{
424+
hashIndex = hashCount;
425+
hashCount += pair.second;
426+
427+
if (!checkFile(pair, &fileHashes[hashIndex], targetDirectory, fileData, journal, progressCallback, checkSizeOnly))
428+
{
429+
return false;
430+
}
431+
}
432+
433+
return true;
434+
}
435+
275436
bool Installer::copyFiles(std::span<const FilePair> filePairs, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, const std::filesystem::path &targetDirectory, const std::string &validationFile, bool skipHashChecks, Journal &journal, const std::function<bool()> &progressCallback)
276437
{
277438
std::error_code ec;
@@ -387,39 +548,8 @@ bool Installer::parseSources(const Input &input, Journal &journal, Sources &sour
387548
}
388549

389550
DLC dlc = detectDLC(path, *dlcSource.sourceVfs, journal);
390-
switch (dlc)
551+
if (!fillDLCSource(dlc, dlcSource))
391552
{
392-
case DLC::Spagonia:
393-
dlcSource.filePairs = { SpagoniaFiles, SpagoniaFilesSize };
394-
dlcSource.fileHashes = SpagoniaHashes;
395-
dlcSource.targetSubDirectory = SpagoniaDirectory;
396-
break;
397-
case DLC::Chunnan:
398-
dlcSource.filePairs = { ChunnanFiles, ChunnanFilesSize };
399-
dlcSource.fileHashes = ChunnanHashes;
400-
dlcSource.targetSubDirectory = ChunnanDirectory;
401-
break;
402-
case DLC::Mazuri:
403-
dlcSource.filePairs = { MazuriFiles, MazuriFilesSize };
404-
dlcSource.fileHashes = MazuriHashes;
405-
dlcSource.targetSubDirectory = MazuriDirectory;
406-
break;
407-
case DLC::Holoska:
408-
dlcSource.filePairs = { HoloskaFiles, HoloskaFilesSize };
409-
dlcSource.fileHashes = HoloskaHashes;
410-
dlcSource.targetSubDirectory = HoloskaDirectory;
411-
break;
412-
case DLC::ApotosShamar:
413-
dlcSource.filePairs = { ApotosShamarFiles, ApotosShamarFilesSize };
414-
dlcSource.fileHashes = ApotosShamarHashes;
415-
dlcSource.targetSubDirectory = ApotosShamarDirectory;
416-
break;
417-
case DLC::EmpireCityAdabat:
418-
dlcSource.filePairs = { EmpireCityAdabatFiles, EmpireCityAdabatFilesSize };
419-
dlcSource.fileHashes = EmpireCityAdabatHashes;
420-
dlcSource.targetSubDirectory = EmpireCityAdabatDirectory;
421-
break;
422-
default:
423553
return false;
424554
}
425555

‎UnleashedRecomp/install/installer.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@ struct Installer
7575
static bool checkGameInstall(const std::filesystem::path &baseDirectory, std::filesystem::path &modulePath);
7676
static bool checkDLCInstall(const std::filesystem::path &baseDirectory, DLC dlc);
7777
static bool checkAllDLC(const std::filesystem::path &baseDirectory);
78+
static bool checkInstallIntegrity(const std::filesystem::path &baseDirectory, Journal &journal, const std::function<bool()> &progressCallback);
7879
static bool computeTotalSize(std::span<const FilePair> filePairs, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, Journal &journal, uint64_t &totalSize);
80+
static bool checkFiles(std::span<const FilePair> filePairs, const uint64_t *fileHashes, const std::filesystem::path &targetDirectory, Journal &journal, const std::function<bool()> &progressCallback, bool checkSizeOnly);
7981
static bool copyFiles(std::span<const FilePair> filePairs, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, const std::filesystem::path &targetDirectory, const std::string &validationFile, bool skipHashChecks, Journal &journal, const std::function<bool()> &progressCallback);
8082
static bool parseContent(const std::filesystem::path &sourcePath, std::unique_ptr<VirtualFileSystem> &targetVfs, Journal &journal);
8183
static bool parseSources(const Input &input, Journal &journal, Sources &sources);

‎UnleashedRecomp/locale/locale.cpp

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -703,6 +703,28 @@ std::unordered_map<std::string_view, std::unordered_map<ELanguage, std::string>>
703703
{ ELanguage::Italian, "Impossibile trovare il modulo \"%s\".\n\nAssicurati che:\n\n- Hai estratto questa copia di Unleashed Recompiled correttamente e non solo il file *.exe.\n- Non stai eseguendo Unleashed Recompiled da un file *.zip." }
704704
}
705705
},
706+
{
707+
"IntegrityCheck_Success",
708+
{
709+
{ ELanguage::English, "Installation check has finished.\n\nAll files seem to be correct.\n\nThe game will now close. Remove the launch argument to play the game." },
710+
{ ELanguage::Japanese, "インストールチェックが終了しました\n\nすべてのファイルは正しいようです\n\nゲームは終了します、ゲームをプレイするには起動引数を削除してください" },
711+
{ ELanguage::German, "Die Installation wurde überprüft.\n\nAlle Dateien scheinen korrekt zu sein.\n\nDas Spiel wird nun geschlossen. Entferne die Startoption, um das Spiel zu spielen." },
712+
{ ELanguage::French, "La vérification de l'installation est terminée.\n\nTous les fichiers semblent corrects.\n\nL'application va maintenant se fermer. Retirez l'argument de lancement pour pouvoir lancer le jeu." },
713+
{ ELanguage::Spanish, "La verificación de la instalación ha terminado.\n\nTodos los archivos parecen correctos.\n\nEl juego se cerrará ahora. Elimina el argumento de lanzamiento para jugar al juego." },
714+
{ ELanguage::Italian, "La verifica dei file d'installazione è terminata.\n\nTutti i file sembrano corretti.\n\nIl gioco si chiuderà. Rimuovi l'argomento di avvio per poter giocare." }
715+
}
716+
},
717+
{
718+
"IntegrityCheck_Failed",
719+
{
720+
{ ELanguage::English, "Installation check has failed.\n\nError: %s\n\nThe game will now close. Try reinstalling the game by using the --install launch argument." },
721+
{ ELanguage::Japanese, "インストールチェックに失敗しました\n\nエラー：%s\n\nゲームは終了します、--install 起動引数を使用してゲームを再インストールしてください" },
722+
{ ELanguage::German, "Die Installationsprüfung ist fehlgeschlagen.\n\nFehler: %s\n\nDas Spiel wird nun geschlossen. Versuche das Spiel durch Verwendung der Startoption --install neu zu installieren." },
723+
{ ELanguage::French, "La vérification de l'installation a échoué.\n\nErreur : %s\n\nL'application va maintenant se fermer. Essayez de réinstaller le jeu en utilisant l'argument de lancement --install." },
724+
{ ELanguage::Spanish, "La verificación de la instalación ha fallado.\n\nError: %s\n\nEl juego se cerrará ahora. Intenta reinstalar el juego utilizando el argumento de lanzamiento --install." },
725+
{ ELanguage::Italian, "La verifica dei file d'installazione non è andata a buon fine.\n\nErrore: %s\n\nIl gioco si chiuderà. Prova a reinstallare il gioco utilizzando l'argomento di avvio --install." }
726+
}
727+
},
706728
{
707729
"Common_On",
708730
{

‎UnleashedRecomp/main.cpp

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,13 +200,15 @@ int main(int argc, char *argv[])
200200
bool forceInstaller = false;
201201
bool forceDLCInstaller = false;
202202
bool useDefaultWorkingDirectory = false;
203+
bool forceInstallationCheck = false;
203204
const char *sdlVideoDriver = nullptr;
204205

205206
for (uint32_t i = 1; i < argc; i++)
206207
{
207208
forceInstaller = forceInstaller || (strcmp(argv[i], "--install") == 0);
208209
forceDLCInstaller = forceDLCInstaller || (strcmp(argv[i], "--install-dlc") == 0);
209210
useDefaultWorkingDirectory = useDefaultWorkingDirectory || (strcmp(argv[i], "--use-cwd") == 0);
211+
forceInstallationCheck = forceInstallationCheck || (strcmp(argv[i], "--install-check") == 0);
210212

211213
if (strcmp(argv[i], "--sdl-video-driver") == 0)
212214
{
@@ -226,6 +228,56 @@ int main(int argc, char *argv[])
226228

227229
Config::Load();
228230

231+
if (forceInstallationCheck)
232+
{
233+
Journal journal;
234+
double lastProgressMiB = 0.0;
235+
double lastTotalMib = 0.0;
236+
Installer::checkInstallIntegrity(GAME_INSTALL_DIRECTORY, journal, [&]()
237+
{
238+
constexpr double MiBDivisor = 1024.0 * 1024.0;
239+
constexpr double MiBProgressThreshold = 128.0;
240+
double progressMiB = double(journal.progressCounter) / MiBDivisor;
241+
double totalMiB = double(journal.progressTotal) / MiBDivisor;
242+
if (journal.progressCounter > 0)
243+
{
244+
if ((progressMiB - lastProgressMiB) > MiBProgressThreshold)
245+
{
246+
fprintf(stdout, "Checking files: %0.2f MiB / %0.2f MiB\n", progressMiB, totalMiB);
247+
lastProgressMiB = progressMiB;
248+
}
249+
}
250+
else
251+
{
252+
if ((totalMiB - lastTotalMib) > MiBProgressThreshold)
253+
{
254+
fprintf(stdout, "Scanning files: %0.2f MiB\n", totalMiB);
255+
lastTotalMib = totalMiB;
256+
}
257+
}
258+
259+
return true;
260+
});
261+
262+
char resultText[512];
263+
uint32_t messageBoxStyle;
264+
if (journal.lastResult == Journal::Result::Success)
265+
{
266+
snprintf(resultText, sizeof(resultText), "%s", Localise("IntegrityCheck_Success").c_str());
267+
fprintf(stdout, "%s\n", resultText);
268+
messageBoxStyle = SDL_MESSAGEBOX_INFORMATION;
269+
}
270+
else
271+
{
272+
snprintf(resultText, sizeof(resultText), Localise("IntegrityCheck_Failed").c_str(), journal.lastErrorMessage.c_str());
273+
fprintf(stderr, "%s\n", resultText);
274+
messageBoxStyle = SDL_MESSAGEBOX_ERROR;
275+
}
276+
277+
SDL_ShowSimpleMessageBox(messageBoxStyle, GameWindow::GetTitle(), resultText, GameWindow::s_pWindow);
278+
std::_Exit(int(journal.lastResult));
279+
}
280+
229281
#if defined(_WIN32) && defined(UNLEASHED_RECOMP_D3D12)
230282
for (auto& dll : g_D3D12RequiredModules)
231283
{

0 commit comments

Comments
 (0)