FF8: Enable override_path option for FF8

Author: myst6re

Changelog.md

@@ -21,6 +21,7 @@
 - External textures: Fix filename lookup which can match more textures than it should in a VRAM page ( https://github.com/julianxhokaxhiu/FFNx/pull/687 )
 - External textures: Split `battle/A8DEF.TIM` into three files to avoid redundant textures ( https://github.com/julianxhokaxhiu/FFNx/pull/687 )
 - External music: Fix music get stopped in Fisherman's Horizon concert ( https://github.com/julianxhokaxhiu/FFNx/pull/694 )
+- Files: Enable support for `override_path` option ( https://github.com/julianxhokaxhiu/FFNx/pull/705 )
 - Rendering: Avoid texture reupload in case of palette swap ( https://github.com/julianxhokaxhiu/FFNx/pull/687 )
 - Rendering: Fix texture unload when multiple palettes are written ( https://github.com/julianxhokaxhiu/FFNx/pull/687 )
 - Rendering: Prevent the game from sending textures with half-alpha colors ( https://github.com/julianxhokaxhiu/FFNx/pull/687 )

src/common.cpp

@@ -65,6 +65,7 @@
 #include "ff8/engine.h"
 #include "ff8/uv_patch.h"
 #include "ff8/ambient.h"
+#include "ff8/file.h"
 
 #include "wine.h"
 
@@ -3261,11 +3262,16 @@ __declspec(dllexport) LSTATUS __stdcall dotemuRegQueryValueExA(HKEY hKey, LPCSTR
 
 __declspec(dllexport) HANDLE __stdcall dotemuCreateFileA(LPCSTR lpFileName, DWORD dwDesiredAccess, DWORD dwShareMode, LPSECURITY_ATTRIBUTES lpSecurityAttributes, DWORD dwCreationDisposition, DWORD dwFlagsAndAttributes, HANDLE hTemplateFile)
 {
+	if (ff8_fs_last_fopen_is_redirected())
+	{
+		return CreateFileA(lpFileName, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwCreationDisposition, dwFlagsAndAttributes, hTemplateFile);
+	}
+
 	HANDLE ret = INVALID_HANDLE_VALUE;
 
 	if (strstr(lpFileName, "CD:") != NULL)
 	{
-		CHAR newPath[260]{ 0 };
+		CHAR newPath[MAX_PATH]{ 0 };
 		uint8_t requiredDisk = *(uint8_t*)(*(DWORD*)ff8_externals.requiredDisk + 0xCC);
 		CHAR diskAsChar[2];
 
@@ -3289,31 +3295,31 @@ __declspec(dllexport) HANDLE __stdcall dotemuCreateFileA(LPCSTR lpFileName, DWOR
 	}
 	else if (strstr(lpFileName, "app.log") || strstr(lpFileName, "ff8input.cfg"))
 	{
-		CHAR newPath[260]{ 0 };
+		CHAR newPath[MAX_PATH]{ 0 };
 
 		// Search for the last '\' character and get a pointer to the next char
 		const char* pos = strrchr(lpFileName, 92) + 1;
 
-		get_userdata_path(newPath, 260, false);
+		get_userdata_path(newPath, sizeof(newPath), false);
 		PathAppendA(newPath, JP_VERSION ? "ff8input_jp.cfg" : pos);
 
 		ret = CreateFileA(newPath, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwCreationDisposition, dwFlagsAndAttributes, hTemplateFile);
 	}
 	else if (strstr(lpFileName, "temp.fi") || strstr(lpFileName, "temp.fl") || strstr(lpFileName, "temp.fs") || strstr(lpFileName, "temp_evn.") || strstr(lpFileName, "temp_odd."))
 	{
-		CHAR newPath[260]{ 0 };
+		CHAR newPath[MAX_PATH]{ 0 };
 
 		// Search for the last '\' character and get a pointer to the next char
 		const char* pos = strrchr(lpFileName, 92) + 1;
 
-		get_userdata_path(newPath, 260, false);
+		get_userdata_path(newPath, sizeof(newPath), false);
 		PathAppendA(newPath, pos);
 
 		ret = CreateFileA(newPath, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwCreationDisposition, dwFlagsAndAttributes, hTemplateFile);
 	}
 	else if (strstr(lpFileName, ".fi") != NULL || strstr(lpFileName, ".fl") != NULL || strstr(lpFileName, ".fs") != NULL)
 	{
-		CHAR newPath[260]{ 0 };
+		CHAR newPath[MAX_PATH]{ 0 };
 
 		// Search for the last '\' character and get a pointer to the next char
 		const char* pos = strrchr(lpFileName, 92) + 1;
@@ -3325,7 +3331,7 @@ __declspec(dllexport) HANDLE __stdcall dotemuCreateFileA(LPCSTR lpFileName, DWOR
 	}
 	else if (StrStrIA(lpFileName, R"(SAVE\)") != NULL) // SAVE\SLOTX\saveN or save\chocorpg
 	{
-		CHAR newPath[260]{ 0 };
+		CHAR newPath[MAX_PATH]{ 0 };
 		CHAR saveFileName[50]{ 0 };
 
 		// Search for the next character pointer after "SAVE\"

src/ff8.h

@@ -1051,6 +1051,7 @@ struct ff8_externals
 	uint32_t (*sm_pc_read)(char*,void*);
 	uint32_t get_disk_number;
 	char* disk_data_path;
+	const char *app_path;
 	uint32_t swirl_main_loop;
 	uint32_t field_main_loop;
 	uint32_t field_main_exit;

src/ff8/file.cpp

@@ -23,11 +23,13 @@
 #include "file.h"
 #include "../ff8.h"
 #include "../log.h"
+#include "../redirect.h"
 
 #include <fcntl.h>
 #include <io.h>
 
 char next_direct_file[MAX_PATH] = "";
+bool last_fopen_is_redirected = false;
 
 size_t get_fl_prefix_size()
 {
@@ -115,14 +117,25 @@ void ff8_fs_archive_free_file_container_sub_archive(ff8_file_container *file_con
 	return ff8_externals.free_file_container(file_container);
 }
 
+bool ff8_attempt_redirection(const char *in, char *out, size_t size)
+{
+	// Remove AppPath from input
+	if (strncmp(in, ff8_externals.app_path, strlen(ff8_externals.app_path)) == 0) {
+		// +1 because the last '\' is stripped from AppPath by the game
+		in += strlen(ff8_externals.app_path) + 1;
+	}
+
+	return attempt_redirection(in, out, size) != -1;
+}
+
 int ff8_open(const char *fileName, int oflag, ...)
 {
 	va_list va;
 
 	va_start(va, oflag);
 	int pmode = va_arg(va, int);
 
-	if (trace_all || trace_files) ffnx_trace("%s: %s pmode=%X\n", __func__, fileName, pmode);
+	if (trace_all || trace_files) ffnx_trace("%s: %s oflag=%X pmode=%X\n", __func__, fileName, oflag, pmode);
 
 	if (next_direct_file && *next_direct_file != '\0')
 	{
@@ -135,7 +148,16 @@ int ff8_open(const char *fileName, int oflag, ...)
 		return ret;
 	}
 
-	return ff8_externals._sopen(fileName, oflag, 64, pmode);
+	char _filename[MAX_PATH]{ 0 };
+	bool is_redirected = ff8_attempt_redirection(fileName, _filename, sizeof(_filename));
+
+	last_fopen_is_redirected = is_redirected;
+
+	int ret = ff8_externals._sopen(is_redirected ? _filename : fileName, oflag, 64, pmode);
+
+	last_fopen_is_redirected = false;
+
+	return ret;
 }
 
 FILE *ff8_fopen(const char *fileName, const char *mode)
@@ -153,7 +175,16 @@ FILE *ff8_fopen(const char *fileName, const char *mode)
 		return file;
 	}
 
-	return ff8_externals._fsopen(fileName, mode, 64);
+	char _filename[MAX_PATH]{ 0 };
+	bool is_redirected = ff8_attempt_redirection(fileName, _filename, sizeof(_filename));
+
+	last_fopen_is_redirected = is_redirected;
+
+	FILE *file = ff8_externals._fsopen(is_redirected ? _filename : fileName, mode, 64);
+
+	last_fopen_is_redirected = false;
+
+	return file;
 }
 
 ff8_file *ff8_open_file(ff8_file_context *infos, const char *fs_path)
@@ -234,8 +265,15 @@ ff8_file *ff8_open_file(ff8_file_context *infos, const char *fs_path)
 			}
 			else
 			{
+				char _filename[256]{ 0 };
+				bool is_redirected = ff8_attempt_redirection(fullpath, _filename, sizeof(_filename));
+
+				last_fopen_is_redirected = is_redirected;
+
 				// We need to use the external _open, and not the official one
-				file->fd = ff8_externals._sopen(fullpath, oflag, 64, pmode);
+				file->fd = ff8_externals._sopen(is_redirected ? _filename : fullpath, oflag, 64, pmode);
+
+				last_fopen_is_redirected = false;
 			}
 
 			file->is_open = 1;
@@ -253,3 +291,8 @@ ff8_file *ff8_open_file(ff8_file_context *infos, const char *fs_path)
 
 	return file;
 }
+
+bool ff8_fs_last_fopen_is_redirected()
+{
+	return last_fopen_is_redirected;
+}

src/ff8/file.h

@@ -37,3 +37,5 @@ uint32_t(*ff8_read_file)(uint32_t count, void* buffer, struct ff8_file* file);
 void (*ff8_close_file)(struct ff8_file* file);
 
 void ff8_fs_lang_string(char *data);
+
+bool ff8_fs_last_fopen_is_redirected();

src/ff8_data.cpp

@@ -98,6 +98,7 @@ void ff8_find_externals()
 	ff8_externals.get_disk_number = get_relative_call(ff8_externals.main_loop, 0x1A);
 	ff8_externals.disk_data_path = (char*)get_absolute_value(ff8_externals.get_disk_number, 0xF);
 	ff8_externals.set_game_paths = (void (*)(int, char*, const char*))get_relative_call(ff8_externals.init_config, 0x3E);
+	ff8_externals.app_path = (const char*)get_absolute_value(uint32_t(ff8_externals.set_game_paths), 0x9A);
 
 	ff8_externals.savemap = (uint32_t**)get_absolute_value(ff8_externals.main_loop, 0x21);
 

src/game_cfg.cpp

@@ -24,6 +24,16 @@
 
 #include "patch.h"
 
+void normalize_path(char *name)
+{
+	int idx = 0;
+	while (name[idx] != 0)
+	{
+		if (name[idx] == '/') name[idx] = '\\';
+		idx++;
+	}
+}
+
 void set_game_paths(int install_options, char *_app_path, const char *_dataDrive)
 {
 	char fileName[MAX_PATH] = {};
@@ -33,6 +43,7 @@ void set_game_paths(int install_options, char *_app_path, const char *_dataDrive
 		ffnx_info("Overriding AppPath with %s\n", app_path.c_str());
 		strncpy(fileName, app_path.c_str(), sizeof(fileName));
 		_app_path = fileName;
+		normalize_path(_app_path);
 	}
 
 	if (!steam_edition && !data_drive.empty())

src/redirect.cpp

@@ -25,14 +25,17 @@
 
 #include "redirect.h"
 
-int attempt_redirection(char* in, char* out, size_t size, bool wantsSteamPath)
+int attempt_redirection(const char* in, char* out, size_t size, bool wantsSteamPath)
 {
 	std::string newIn(in);
 
-	std::transform(newIn.begin(), newIn.end(), newIn.begin(), ::tolower);
+	if (!ff8)
+	{
+		std::transform(newIn.begin(), newIn.end(), newIn.begin(), ::tolower);
+	}
 
-	bool isSavegame = strstr(newIn.data(), ".ff7") != NULL;
-	bool isCacheFile = strstr(newIn.data(), ".p") != NULL;
+	bool isSavegame = !ff8 && strstr(newIn.data(), ".ff7") != NULL;
+	bool isCacheFile = !ff8 && strstr(newIn.data(), ".p") != NULL;
 
 	if (wantsSteamPath && !fileExists(in))
 	{
@@ -133,11 +136,11 @@ int attempt_redirection(char* in, char* out, size_t size, bool wantsSteamPath)
 		}
 		else if (!isCacheFile)
 		{
-			const char* pos = strstr(newIn.data(), "data");
+			const char* pos = ff8 ? newIn.data() : strstr(newIn.data(), "data");
 
 			if (pos != NULL)
 			{
-				pos += 5;
+				pos += ff8 ? 0 : 5;
 			}
 			else
 			{
@@ -169,9 +172,9 @@ int attempt_redirection(char* in, char* out, size_t size, bool wantsSteamPath)
 	return -1;
 }
 
-int redirect_path_with_override(char* in, char* out, size_t out_size)
+int redirect_path_with_override(const char* in, char* out, size_t out_size)
 {
-  char _newFilename[260]{ 0 };
+  char _newFilename[MAX_PATH]{ 0 };
 
   // Attempt another redirection based on Steam/eStore logic
   int redirect_status = attempt_redirection(in, _newFilename, sizeof(_newFilename), steam_edition || estore_edition);
@@ -206,4 +209,4 @@ int redirect_path_with_override(char* in, char* out, size_t out_size)
   }
 
   return redirect_status;
-}
+}

src/redirect.h

@@ -19,5 +19,5 @@
 //    GNU General Public License for more details.                          //
 /****************************************************************************/
 
-int attempt_redirection(char* in, char* out, size_t size, bool wantsSteamPath = false);
-int redirect_path_with_override(char* in, char* out, size_t out_size);
+int attempt_redirection(const char* in, char* out, size_t size, bool wantsSteamPath = false);
+int redirect_path_with_override(const char* in, char* out, size_t out_size);