Path: Prevent Path::RealPath from returning '.' and '..' components

common/FileSystem.cpp

@@ -453,6 +453,11 @@ std::string Path::RealPath(const std::string_view path)
 			}
 		}
 	}
+
+	// If any relative symlinks were resolved, there may be '.' and '..'
+	// components in the resultant path, which must be removed.
+	realpath = Path::Canonicalize(realpath);
+
 #endif
 
 	return realpath;
@@ -1961,6 +1966,26 @@ bool FileSystem::SetPathCompression(const char* path, bool enable)
 	return result;
 }
 
+bool FileSystem::CreateSymLink(const char* link, const char* target)
+{
+	// convert to wide string
+	const std::wstring wlink = GetWin32Path(link);
+	if (wlink.empty())
+		return false;
+
+	const std::wstring wtarget = GetWin32Path(target);
+	if (wtarget.empty())
+		return false;
+
+	// check if it's a directory
+	DWORD flags = 0;
+	if (DirectoryExists(target))
+		flags |= SYMBOLIC_LINK_FLAG_DIRECTORY;
+
+	// create the symbolic link
+	return CreateSymbolicLinkW(wlink.c_str(), wtarget.c_str(), flags) != 0;
+}
+
 bool FileSystem::IsSymbolicLink(const char* path)
 {
 	// convert to wide string
@@ -2541,6 +2566,11 @@ bool FileSystem::SetPathCompression(const char* path, bool enable)
 	return false;
 }
 
+bool FileSystem::CreateSymLink(const char* link, const char* target)
+{
+	return symlink(target, link) == 0;
+}
+
 bool FileSystem::IsSymbolicLink(const char* path)
 {
 	struct stat sysStatData;

common/FileSystem.h

@@ -178,6 +178,10 @@ namespace FileSystem
 	/// Does nothing and returns false on non-Windows platforms.
 	bool SetPathCompression(const char* path, bool enable);
 
+	// Creates a symbolic link. Note that on Windows this requires elevated
+	// privileges so this is mostly useful for testing purposes.
+	bool CreateSymLink(const char* link, const char* target);
+
 	/// Checks if a file or directory is a symbolic link.
 	bool IsSymbolicLink(const char* path);
 

tests/ctest/common/filesystem_tests.cpp

@@ -7,8 +7,6 @@
 
 #ifdef __linux__
 
-#include <unistd.h>
-
 static std::optional<std::string> create_test_directory()
 {
 	for (u16 i = 0; i < UINT16_MAX; i++)
@@ -42,13 +40,13 @@ TEST(FileSystem, RecursiveDeleteDirectoryDontFollowSymbolicLinks)
 	std::string dir_to_delete = Path::Combine(*test_dir, "dir_to_delete");
 	ASSERT_TRUE(FileSystem::CreateDirectoryPath(dir_to_delete.c_str(), false));
 	std::string symlink_path = Path::Combine(dir_to_delete, "link");
-	ASSERT_EQ(symlink(target_dir.c_str(), symlink_path.c_str()), 0);
+	ASSERT_TRUE(FileSystem::CreateSymLink(symlink_path.c_str(), target_dir.c_str()));
 
 	// Delete the directory containing the symlink.
-	ASSERT_TRUE(dir_to_delete.starts_with("/tmp/"));
+	ASSERT_TRUE(dir_to_delete.starts_with("/tmp/pcsx2_filesystem_test_"));
 	ASSERT_TRUE(FileSystem::RecursiveDeleteDirectory(dir_to_delete.c_str()));
 
-	// Make sure the target file didn't get deleted.
+	// Make sure the file in the target directory didn't get deleted.
 	ASSERT_TRUE(FileSystem::FileExists(file_path.c_str()));
 
 	// Clean up.

tests/ctest/common/path_tests.cpp

@@ -1,6 +1,7 @@
 // SPDX-FileCopyrightText: 2002-2024 PCSX2 Dev Team
 // SPDX-License-Identifier: GPL-3.0+
 
+#include "common/FileSystem.h"
 #include "common/Pcsx2Defs.h"
 #include "common/Path.h"
 #include <gtest/gtest.h>
@@ -238,16 +239,129 @@ TEST(Path, CreateFileURL)
 #endif
 }
 
-#if 0
+#if __linux__
 
-// Relies on presence of files.
-TEST(Path, RealPath)
+static std::optional<std::string> create_test_directory()
 {
-#ifdef _WIN32
-	ASSERT_EQ(Path::RealPath("C:\\Users\\Me\\Desktop\\foo\\baz"), "C:\\Users\\Me\\Desktop\\foo\\bar\\baz");
-#else
-	ASSERT_EQ(Path::RealPath("/lib/foo/bar"), "/usr/lib/foo/bar");
-#endif
+	for (u16 i = 0; i < UINT16_MAX; i++)
+	{
+		std::string path = std::string("/tmp/pcsx2_path_test_") + std::to_string(i);
+		if (!FileSystem::DirectoryExists(path.c_str()))
+		{
+			if (!FileSystem::CreateDirectoryPath(path.c_str(), false))
+				break;
+
+			return path;
+		}
+	}
+
+	return std::nullopt;
+}
+
+TEST(Path, RealPathAbsoluteSymbolicLink)
+{
+	std::optional<std::string> test_dir = create_test_directory();
+	ASSERT_TRUE(test_dir.has_value());
+
+	// Create a file to point at.
+	std::string file_path = Path::Combine(*test_dir, "file");
+	ASSERT_TRUE(FileSystem::WriteStringToFile(file_path.c_str(), "Hello, world!"));
+
+	// Create a symbolic link that points to said file.
+	std::string link_path = Path::Combine(*test_dir, "link");
+	ASSERT_TRUE(FileSystem::CreateSymLink(link_path.c_str(), file_path.c_str()));
+
+	// Make sure the symbolic link is resolved correctly.
+	ASSERT_EQ(Path::RealPath(link_path), file_path);
+
+	// Clean up.
+	ASSERT_TRUE(FileSystem::DeleteSymbolicLink(link_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteFilePath(file_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteDirectory(test_dir->c_str()));
+}
+
+TEST(Path, RealPathRelativeSymbolicLink)
+{
+	std::optional<std::string> test_dir = create_test_directory();
+	ASSERT_TRUE(test_dir.has_value());
+
+	// Create a file to point at.
+	std::string file_path = Path::Combine(*test_dir, "file");
+	ASSERT_TRUE(FileSystem::WriteStringToFile(file_path.c_str(), "Hello, world!"));
+
+	// Create a symbolic link that points to said file.
+	std::string link_path = Path::Combine(*test_dir, "link");
+	ASSERT_TRUE(FileSystem::CreateSymLink(link_path.c_str(), "file"));
+
+	// Make sure the symbolic link is resolved correctly.
+	ASSERT_EQ(Path::RealPath(link_path), file_path);
+
+	// Clean up.
+	ASSERT_TRUE(FileSystem::DeleteSymbolicLink(link_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteFilePath(file_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteDirectory(test_dir->c_str()));
+}
+
+TEST(Path, RealPathDotDotSymbolicLink)
+{
+	std::optional<std::string> test_dir = create_test_directory();
+	ASSERT_TRUE(test_dir.has_value());
+
+	// Create a file to point at.
+	std::string file_path = Path::Combine(*test_dir, "file");
+	ASSERT_TRUE(FileSystem::WriteStringToFile(file_path.c_str(), "Hello, world!"));
+
+	// Create a directory to put the link in.
+	std::string link_dir = Path::Combine(*test_dir, "dir");
+	ASSERT_TRUE(FileSystem::CreateDirectoryPath(link_dir.c_str(), false));
+
+	// Create a symbolic link that points to said file.
+	std::string link_path = Path::Combine(link_dir, "link");
+	ASSERT_TRUE(FileSystem::CreateSymLink(link_path.c_str(), "../file"));
+
+	// Make sure the symbolic link is resolved correctly.
+	ASSERT_EQ(Path::RealPath(link_path), file_path);
+
+	// Clean up.
+	ASSERT_TRUE(FileSystem::DeleteSymbolicLink(link_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteDirectory(link_dir.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteFilePath(file_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteDirectory(test_dir->c_str()));
+}
+
+TEST(Path, RealPathCircularSymbolicLink)
+{
+	std::optional<std::string> test_dir = create_test_directory();
+	ASSERT_TRUE(test_dir.has_value());
+
+	// Create a circular symbolic link.
+	std::string link_path = Path::Combine(*test_dir, "link");
+	ASSERT_TRUE(FileSystem::CreateSymLink(link_path.c_str(), "."));
+
+	// Make sure the link gets resolved correctly.
+	ASSERT_EQ(Path::RealPath(link_path), *test_dir);
+	ASSERT_EQ(Path::RealPath(Path::Combine(link_path, "link")), *test_dir);
+
+	// Clean up.
+	ASSERT_TRUE(FileSystem::DeleteSymbolicLink(link_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteDirectory(test_dir->c_str()));
+}
+
+TEST(Path, RealPathLoopingSymbolicLink)
+{
+	std::optional<std::string> test_dir = create_test_directory();
+	ASSERT_TRUE(test_dir.has_value());
+
+	// Create a symbolic link that points to itself.
+	std::string link_path = Path::Combine(*test_dir, "link");
+	ASSERT_TRUE(FileSystem::CreateSymLink(link_path.c_str(), "link"));
+
+	// Make sure this doesn't cause problems.
+	ASSERT_EQ(Path::RealPath(link_path), link_path);
+
+	// Clean up.
+	ASSERT_TRUE(FileSystem::DeleteSymbolicLink(link_path.c_str()));
+	ASSERT_TRUE(FileSystem::DeleteDirectory(test_dir->c_str()));
 }
 
 #endif