Valve/Proton
1
0
Fork 0
mirror of https://github.com/ValveSoftware/Proton.git synced 2025-03-26 04:09:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

proton: Add file_exists helper function

Browse Source 
To make desired handling of symlinks more clear at the callsite.
This commit is contained in:
Andrew Eikum 2022-02-09 09:10:04 -06:00
parent bb8dca3f1c
commit 9a8fe6e665
1 changed files with 48 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
proton
View File

@ -36,6 +36,13 @@ CURRENT_PREFIX_VERSION="6.3-3"
PFX="Proton: " PFX="Proton: "
ld_path_var = "LD_LIBRARY_PATH" ld_path_var = "LD_LIBRARY_PATH"
def file_exists(s, *, follow_symlinks):
if follow_symlinks:
#'exists' returns False on broken symlinks
return os.path.exists(s)
#'lexists' returns True on broken symlinks
return os.path.lexists(s)
def nonzero(s): def nonzero(s):
return len(s) > 0 and s != "0" return len(s) > 0 and s != "0"
@ -61,7 +68,7 @@ def file_is_wine_builtin_dll(path):
if os.path.dirname(contents).endswith(('/lib/wine', '/lib/wine/fakedlls', '/lib64/wine', '/lib64/wine/fakedlls')): if os.path.dirname(contents).endswith(('/lib/wine', '/lib/wine/fakedlls', '/lib64/wine', '/lib64/wine/fakedlls')):
# This may be a broken link to a dll in a removed Proton install # This may be a broken link to a dll in a removed Proton install
return True return True
if not os.path.exists(path): if not file_exists(path, follow_symlinks=True):
return False return False
try: try:
sfile = open(path, "rb") sfile = open(path, "rb")
@ -94,17 +101,17 @@ def merge_user_dir(src, dst):
#we only want to copy into directories which don't already exist. games #we only want to copy into directories which don't already exist. games
#may not react well to two save directory instances being merged. #may not react well to two save directory instances being merged.
if not os.path.exists(dst_dir) or os.path.samefile(dst_dir, dst): if not file_exists(dst_dir, follow_symlinks=True) or os.path.samefile(dst_dir, dst):
makedirs(dst_dir) makedirs(dst_dir)
for dir_ in dirs: for dir_ in dirs:
src_file = os.path.join(src_dir, dir_) src_file = os.path.join(src_dir, dir_)
dst_file = os.path.join(dst_dir, dir_) dst_file = os.path.join(dst_dir, dir_)
if os.path.islink(src_file) and not os.path.exists(dst_file): if os.path.islink(src_file) and not file_exists(dst_file, follow_symlinks=True):
try_copy(src_file, dst_file, copy_metadata=True, follow_symlinks=False) try_copy(src_file, dst_file, copy_metadata=True, follow_symlinks=False)
for file_ in files: for file_ in files:
src_file = os.path.join(src_dir, file_) src_file = os.path.join(src_dir, file_)
dst_file = os.path.join(dst_dir, file_) dst_file = os.path.join(dst_dir, file_)
if not os.path.exists(dst_file): if not file_exists(dst_file, follow_symlinks=True):
try_copy(src_file, dst_file, copy_metadata=True, follow_symlinks=False) try_copy(src_file, dst_file, copy_metadata=True, follow_symlinks=False)
else: else:
extant_dirs += dst_dir extant_dirs += dst_dir
@ -113,11 +120,11 @@ def try_copy(src, dst, add_write_perm=True, copy_metadata=False, optional=False,
try: try:
if os.path.isdir(dst): if os.path.isdir(dst):
dstfile = dst + "/" + os.path.basename(src) dstfile = dst + "/" + os.path.basename(src)
if os.path.lexists(dstfile): if file_exists(dstfile, follow_symlinks=False):
os.remove(dstfile) os.remove(dstfile)
else: else:
dstfile = dst dstfile = dst
if os.path.lexists(dst): if file_exists(dst, follow_symlinks=False):
os.remove(dst) os.remove(dst)
if copy_metadata: if copy_metadata:
@ -146,9 +153,9 @@ def try_copyfile(src, dst):
try: try:
if os.path.isdir(dst): if os.path.isdir(dst):
dstfile = dst + "/" + os.path.basename(src) dstfile = dst + "/" + os.path.basename(src)
if os.path.lexists(dstfile): if file_exists(dstfile, follow_symlinks=False):
os.remove(dstfile) os.remove(dstfile)
elif os.path.lexists(dst): elif file_exists(dst, follow_symlinks=False):
os.remove(dst) os.remove(dst)
shutil.copyfile(src, dst) shutil.copyfile(src, dst)
except PermissionError as e: except PermissionError as e:
@ -254,7 +261,7 @@ def find_nvidia_wine_dll_dir():
nvidia_wine_dir = os.path.join(os.path.dirname(libglx_nvidia_realpath), "nvidia", "wine") nvidia_wine_dir = os.path.join(os.path.dirname(libglx_nvidia_realpath), "nvidia", "wine")
# Check that nvngx.dll exists here, or fail # Check that nvngx.dll exists here, or fail
if os.path.exists(os.path.join(nvidia_wine_dir, "nvngx.dll")): if file_exists(os.path.join(nvidia_wine_dir, "nvngx.dll"), follow_symlinks=True):
return nvidia_wine_dir return nvidia_wine_dir
return None return None
@ -301,21 +308,21 @@ class Proton:
def cleanup_legacy_dist(self): def cleanup_legacy_dist(self):
old_dist_dir = self.path("dist/") old_dist_dir = self.path("dist/")
if os.path.exists(old_dist_dir): if file_exists(old_dist_dir, follow_symlinks=True):
with self.dist_lock: with self.dist_lock:
if os.path.exists(old_dist_dir): if file_exists(old_dist_dir, follow_symlinks=True):
shutil.rmtree(old_dist_dir) shutil.rmtree(old_dist_dir)
def do_steampipe_fixups(self): def do_steampipe_fixups(self):
fixups_json = self.path("steampipe_fixups.json") fixups_json = self.path("steampipe_fixups.json")
fixups_mtime = self.path("files/steampipe_fixups_mtime") fixups_mtime = self.path("files/steampipe_fixups_mtime")
if os.path.exists(fixups_json): if file_exists(fixups_json, follow_symlinks=True):
with self.dist_lock: with self.dist_lock:
import steampipe_fixups import steampipe_fixups
current_fixup_mtime = None current_fixup_mtime = None
if os.path.exists(fixups_mtime): if file_exists(fixups_mtime, follow_symlinks=True):
with open(fixups_mtime, "r") as f: with open(fixups_mtime, "r") as f:
current_fixup_mtime = f.readline().strip() current_fixup_mtime = f.readline().strip()
@ -355,7 +362,7 @@ class CompatData:
return self.base_dir + d return self.base_dir + d
def remove_tracked_files(self): def remove_tracked_files(self):
if not os.path.exists(self.tracked_files_file): if not file_exists(self.tracked_files_file, follow_symlinks=True):
log("Prefix has no tracked_files??") log("Prefix has no tracked_files??")
return return
@ -363,7 +370,7 @@ class CompatData:
dirs = [] dirs = []
for f in tracked_files: for f in tracked_files:
path = self.prefix_dir + f.strip() path = self.prefix_dir + f.strip()
if os.path.exists(path): if file_exists(path, follow_symlinks=True):
if os.path.isfile(path) or os.path.islink(path): if os.path.isfile(path) or os.path.islink(path):
os.remove(path) os.remove(path)
else: else:
@ -403,21 +410,21 @@ class CompatData:
(int(new_proton_maj) == int(old_proton_maj) and \ (int(new_proton_maj) == int(old_proton_maj) and \
int(new_proton_min) < int(old_proton_min)): int(new_proton_min) < int(old_proton_min)):
log("Removing newer prefix") log("Removing newer prefix")
if old_proton_ver == "3.7" and not os.path.exists(self.tracked_files_file): if old_proton_ver == "3.7" and not file_exists(self.tracked_files_file, follow_symlinks=True):
#proton 3.7 did not generate tracked_files, so copy it into place first #proton 3.7 did not generate tracked_files, so copy it into place first
try_copy(g_proton.path("proton_3.7_tracked_files"), self.tracked_files_file) try_copy(g_proton.path("proton_3.7_tracked_files"), self.tracked_files_file)
self.remove_tracked_files() self.remove_tracked_files()
return return
if old_proton_ver == "3.7" and old_prefix_ver == "1": if old_proton_ver == "3.7" and old_prefix_ver == "1":
if not os.path.exists(self.prefix_dir + "/drive_c/windows/syswow64/kernel32.dll"): if not file_exists(self.prefix_dir + "/drive_c/windows/syswow64/kernel32.dll", follow_symlinks=True):
#shipped a busted 64-bit-only installation on 20180822. detect and wipe clean #shipped a busted 64-bit-only installation on 20180822. detect and wipe clean
log("Detected broken 64-bit-only installation, re-creating prefix.") log("Detected broken 64-bit-only installation, re-creating prefix.")
shutil.rmtree(self.prefix_dir) shutil.rmtree(self.prefix_dir)
return return
#replace broken .NET installations with wine-mono support #replace broken .NET installations with wine-mono support
if os.path.exists(self.prefix_dir + "/drive_c/windows/Microsoft.NET/NETFXRepair.exe") and \ if file_exists(self.prefix_dir + "/drive_c/windows/Microsoft.NET/NETFXRepair.exe", follow_symlinks=True) and \
file_is_wine_builtin_dll(self.prefix_dir + "/drive_c/windows/system32/mscoree.dll"): file_is_wine_builtin_dll(self.prefix_dir + "/drive_c/windows/system32/mscoree.dll"):
log("Broken .NET installation detected, switching to wine-mono.") log("Broken .NET installation detected, switching to wine-mono.")
#deleting this directory allows wine-mono to work #deleting this directory allows wine-mono to work
@ -498,7 +505,7 @@ class CompatData:
stale_builtins = [self.prefix_dir + "/drive_c/windows/system32/amd_ags_x64.dll", stale_builtins = [self.prefix_dir + "/drive_c/windows/system32/amd_ags_x64.dll",
self.prefix_dir + "/drive_c/windows/syswow64/amd_ags_x64.dll" ] self.prefix_dir + "/drive_c/windows/syswow64/amd_ags_x64.dll" ]
for builtin in stale_builtins: for builtin in stale_builtins:
if os.path.lexists(builtin) and file_is_wine_builtin_dll(builtin): if file_exists(builtin, follow_symlinks=False) and file_is_wine_builtin_dll(builtin):
log("Removing stale builtin " + builtin) log("Removing stale builtin " + builtin)
os.remove(builtin) os.remove(builtin)
@ -528,18 +535,18 @@ class CompatData:
if len(rel_dir) > 0: if len(rel_dir) > 0:
rel_dir = rel_dir + "/" rel_dir = rel_dir + "/"
dst_dir = src_dir.replace(g_proton.default_pfx_dir, self.prefix_dir, 1) dst_dir = src_dir.replace(g_proton.default_pfx_dir, self.prefix_dir, 1)
if not os.path.lexists(dst_dir): if not file_exists(dst_dir, follow_symlinks=False):
os.makedirs(dst_dir) os.makedirs(dst_dir)
tracked_files.write(rel_dir + "\n") tracked_files.write(rel_dir + "\n")
for dir_ in dirs: for dir_ in dirs:
src_file = os.path.join(src_dir, dir_) src_file = os.path.join(src_dir, dir_)
dst_file = os.path.join(dst_dir, dir_) dst_file = os.path.join(dst_dir, dir_)
if os.path.islink(src_file) and not os.path.exists(dst_file): if os.path.islink(src_file) and not file_exists(dst_file, follow_symlinks=True):
self.pfx_copy(src_file, dst_file) self.pfx_copy(src_file, dst_file)
for file_ in files: for file_ in files:
src_file = os.path.join(src_dir, file_) src_file = os.path.join(src_dir, file_)
dst_file = os.path.join(dst_dir, file_) dst_file = os.path.join(dst_dir, file_)
if not os.path.exists(dst_file): if not file_exists(dst_file, follow_symlinks=True):
self.pfx_copy(src_file, dst_file) self.pfx_copy(src_file, dst_file)
tracked_files.write(rel_dir + file_ + "\n") tracked_files.write(rel_dir + file_ + "\n")
# Set .update-timestamp so Wine doesn't try to update the prefix. # Set .update-timestamp so Wine doesn't try to update the prefix.
@ -560,7 +567,7 @@ class CompatData:
if len(rel_dir) > 0: if len(rel_dir) > 0:
rel_dir = rel_dir + "/" rel_dir = rel_dir + "/"
dst_dir = src_dir.replace(g_proton.default_pfx_dir, self.prefix_dir, 1) dst_dir = src_dir.replace(g_proton.default_pfx_dir, self.prefix_dir, 1)
if not os.path.lexists(dst_dir): if not file_exists(dst_dir, follow_symlinks=False):
os.makedirs(dst_dir) os.makedirs(dst_dir)
tracked_files.write(rel_dir + "\n") tracked_files.write(rel_dir + "\n")
for file_ in files: for file_ in files:
@ -571,7 +578,7 @@ class CompatData:
continue continue
if file_is_wine_builtin_dll(dst_file): if file_is_wine_builtin_dll(dst_file):
os.unlink(dst_file) os.unlink(dst_file)
elif os.path.lexists(dst_file): elif file_exists(dst_file, follow_symlinks=False):
# builtin library was replaced # builtin library was replaced
continue continue
else: else:
@ -604,7 +611,7 @@ class CompatData:
for p in fontsmap: for p in fontsmap:
lname = os.path.join(windowsfonts, p[2]) lname = os.path.join(windowsfonts, p[2])
fname = os.path.join(p[0], p[1]) fname = os.path.join(p[0], p[1])
if os.path.lexists(lname): if file_exists(lname, follow_symlinks=False):
if os.path.islink(lname): if os.path.islink(lname):
os.remove(lname) os.remove(lname)
os.symlink(fname, lname) os.symlink(fname, lname)
@ -629,15 +636,15 @@ class CompatData:
#running unofficial Proton/Wine builds against a Proton prefix could #running unofficial Proton/Wine builds against a Proton prefix could
#create an infinite symlink loop. detect this and clean it up. #create an infinite symlink loop. detect this and clean it up.
if os.path.lexists(new) and os.path.islink(new) and os.readlink(new).endswith(old): if file_exists(new, follow_symlinks=False) and os.path.islink(new) and os.readlink(new).endswith(old):
os.remove(new) os.remove(new)
old = self.prefix_dir + old old = self.prefix_dir + old
if os.path.lexists(old) and not os.path.islink(old): if file_exists(old, follow_symlinks=False) and not os.path.islink(old):
merge_user_dir(src=old, dst=new) merge_user_dir(src=old, dst=new)
os.rename(old, old + " BACKUP") os.rename(old, old + " BACKUP")
if not os.path.lexists(old): if not file_exists(old, follow_symlinks=False):
makedirs(os.path.dirname(old)) makedirs(os.path.dirname(old))
os.symlink(src=link, dst=old) os.symlink(src=link, dst=old)
elif os.path.islink(old) and not (os.readlink(old) == link): elif os.path.islink(old) and not (os.readlink(old) == link):
@ -652,7 +659,7 @@ class CompatData:
config_dir = self.prefix_dir + "drive_c/users/steamuser/My Documents/My Games/FINAL FANTASY XIV - A Realm Reborn/" config_dir = self.prefix_dir + "drive_c/users/steamuser/My Documents/My Games/FINAL FANTASY XIV - A Realm Reborn/"
config_file = config_dir + "FFXIV_BOOT.cfg" config_file = config_dir + "FFXIV_BOOT.cfg"
if os.path.exists(config_file): if file_exists(config_file, follow_symlinks=True):
with open(config_file, "r") as file: with open(config_file, "r") as file:
config_content = file.read() config_content = file.read()
config_content = config_content.replace("Browser\t2", "Browser\t1") config_content = config_content.replace("Browser\t2", "Browser\t1")
@ -666,7 +673,7 @@ class CompatData:
def setup_prefix(self): def setup_prefix(self):
with self.prefix_lock: with self.prefix_lock:
if os.path.exists(self.version_file): if file_exists(self.version_file, follow_symlinks=True):
with open(self.version_file, "r") as f: with open(self.version_file, "r") as f:
old_ver = f.readline().strip() old_ver = f.readline().strip()
else: else:
@ -674,19 +681,19 @@ class CompatData:
self.upgrade_pfx(old_ver) self.upgrade_pfx(old_ver)
if not os.path.exists(self.prefix_dir): if not file_exists(self.prefix_dir, follow_symlinks=True):
makedirs(self.prefix_dir + "/drive_c") makedirs(self.prefix_dir + "/drive_c")
set_dir_casefold_bit(self.prefix_dir + "/drive_c") set_dir_casefold_bit(self.prefix_dir + "/drive_c")
if not os.path.exists(self.prefix_dir + "/user.reg"): if not file_exists(self.prefix_dir + "/user.reg", follow_symlinks=True):
self.copy_pfx() self.copy_pfx()
self.migrate_user_paths() self.migrate_user_paths()
if not os.path.lexists(self.prefix_dir + "/dosdevices/c:"): if not file_exists(self.prefix_dir + "/dosdevices/c:", follow_symlinks=False):
os.symlink("../drive_c", self.prefix_dir + "/dosdevices/c:") os.symlink("../drive_c", self.prefix_dir + "/dosdevices/c:")
if not os.path.lexists(self.prefix_dir + "/dosdevices/z:"): if not file_exists(self.prefix_dir + "/dosdevices/z:", follow_symlinks=False):
os.symlink("/", self.prefix_dir + "/dosdevices/z:") os.symlink("/", self.prefix_dir + "/dosdevices/z:")
# collect configuration info # collect configuration info
@ -854,9 +861,9 @@ class CompatData:
else: else:
nvapi64_dll = self.prefix_dir + "drive_c/windows/system32/nvapi64.dll" nvapi64_dll = self.prefix_dir + "drive_c/windows/system32/nvapi64.dll"
nvapi32_dll = self.prefix_dir + "drive_c/windows/syswow64/nvapi.dll" nvapi32_dll = self.prefix_dir + "drive_c/windows/syswow64/nvapi.dll"
if os.path.exists(nvapi64_dll): if file_exists(nvapi64_dll, follow_symlinks=True):
os.unlink(nvapi64_dll) os.unlink(nvapi64_dll)
if os.path.exists(nvapi32_dll): if file_exists(nvapi32_dll, follow_symlinks=True):
os.unlink(nvapi32_dll) os.unlink(nvapi32_dll)
# Try to detect known DLLs that ship with the NVIDIA Linux Driver # Try to detect known DLLs that ship with the NVIDIA Linux Driver
@ -877,17 +884,17 @@ class CompatData:
if "gamedrive" in g_session.compat_config: if "gamedrive" in g_session.compat_config:
library_dir = try_get_game_library_dir() library_dir = try_get_game_library_dir()
if not library_dir: if not library_dir:
if os.path.lexists(gamedrive_path): if file_exists(gamedrive_path, follow_symlinks=False):
os.remove(gamedrive_path) os.remove(gamedrive_path)
else: else:
if os.path.lexists(gamedrive_path): if file_exists(gamedrive_path, follow_symlinks=False):
cur_tgt = os.readlink(gamedrive_path) cur_tgt = os.readlink(gamedrive_path)
if cur_tgt != library_dir: if cur_tgt != library_dir:
os.remove(gamedrive_path) os.remove(gamedrive_path)
os.symlink(library_dir, gamedrive_path) os.symlink(library_dir, gamedrive_path)
else: else:
os.symlink(library_dir, gamedrive_path) os.symlink(library_dir, gamedrive_path)
elif os.path.lexists(gamedrive_path): elif file_exists(gamedrive_path, follow_symlinks=False):
os.remove(gamedrive_path) os.remove(gamedrive_path)
# add Steam ffmpeg libraries to path # add Steam ffmpeg libraries to path
@ -999,7 +1006,7 @@ class Session:
lfile_path = basedir + "/steam-" + os.environ["SteamGameId"] + ".log" lfile_path = basedir + "/steam-" + os.environ["SteamGameId"] + ".log"
if os.path.exists(lfile_path): if file_exists(lfile_path, follow_symlinks=True):
os.remove(lfile_path) os.remove(lfile_path)
makedirs(basedir) makedirs(basedir)
@ -1011,7 +1018,7 @@ class Session:
#load environment overrides #load environment overrides
used_user_settings = {} used_user_settings = {}
if os.path.exists(g_proton.user_settings_file): if file_exists(g_proton.user_settings_file, follow_symlinks=True):
try: try:
import user_settings import user_settings
for key, value in user_settings.user_settings.items(): for key, value in user_settings.user_settings.items():