mirror of
https://github.com/Droid-Deck/DroidDeck.git
synced 2026-11-18 20:36:04 +00:00
fix(steam): share the Steam app's prefix with shortcuts of the same install (#2463)
* fix(steam): share the Steam app's prefix with shortcuts of the same install * fix(steam): prefer the matching install's save prefix * fix(steam): tolerate an unreadable library when linking a shortcut prefix A library folder that cannot be listed made the shortcut writer exit, so no added game was registered. * fix(steam): repair a dangling shortcut prefix link and keep Steam library installs to their own prefix * fix(steam): only change shortcut prefix links the importer created * fix(steam): record a prefix link only when the importer created it
This commit is contained in:
1 parent
52bf19ad8e
commit
a1dfb96708
3 files changed
+239
-3
No files matched your search
@@ -3,6 +3,7 @@ import importlib.util
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import subprocess
|
||||
import tempfile
|
||||
import unittest
|
||||
@@ -56,6 +57,171 @@ class ImportsTest(unittest.TestCase):
|
||||
self.assertEqual(self.folder, (self.steam / 'steamapps/common/DroidDeck-42').resolve())
|
||||
self.assertEqual(b'game', self.exe.read_bytes())
|
||||
|
||||
def steam_install(self, appid=42):
|
||||
library = self.root / 'Library'
|
||||
folder = library / 'steamapps/common/Example'
|
||||
folder.mkdir(parents=True)
|
||||
(folder / 'Example.exe').write_bytes(b'game')
|
||||
(library / f'steamapps/appmanifest_{appid}.acf').write_text(f'"AppState"\n{{\n"appid" "{appid}"\n"installdir" "Example"\n}}\n')
|
||||
saves = library / f'steamapps/compatdata/{appid}/pfx/drive_c/users/steamuser'
|
||||
saves.mkdir(parents=True)
|
||||
(saves / 'save.dat').write_bytes(b'cloud')
|
||||
return dict(self.game, folder=str(folder), exe=str(folder / 'Example.exe'), dir=str(folder)), library
|
||||
|
||||
def shortcut_prefix(self):
|
||||
return self.steam / 'steamapps/compatdata' / str(self.game['appid'] & 0xFFFFFFFF)
|
||||
|
||||
def link_shortcut_prefix(self, target, owned=True):
|
||||
(self.steam / 'steamapps/compatdata').mkdir(parents=True, exist_ok=True)
|
||||
self.shortcut_prefix().symlink_to(target)
|
||||
if owned:
|
||||
imports.save_json(self.steam / 'steamapps' / imports.PREFIX_LINKS,
|
||||
{str(self.shortcut_prefix()): str(target)})
|
||||
|
||||
def test_shortcut_of_a_steam_install_shares_the_steam_apps_prefix(self):
|
||||
game, library = self.steam_install()
|
||||
(self.steam / 'steamapps').mkdir(parents=True)
|
||||
(self.steam / 'steamapps/libraryfolders.vdf').write_text(f'"libraryfolders"\n{{\n"1" {{ "path" "{library}" }}\n}}\n')
|
||||
games, routes = imports.route(self.steam, self.acct, [game])
|
||||
self.assertEqual(([game], {}), (games, routes))
|
||||
self.assertEqual(library / 'steamapps/compatdata/42', self.shortcut_prefix().resolve())
|
||||
self.assertEqual(b'cloud', (self.shortcut_prefix() / 'pfx/drive_c/users/steamuser/save.dat').read_bytes())
|
||||
|
||||
def test_matching_install_prefix_precedes_an_older_prefix_in_another_library(self):
|
||||
game, library = self.steam_install()
|
||||
(self.steam / 'steamapps').mkdir(parents=True)
|
||||
(self.steam / 'steamapps/libraryfolders.vdf').write_text(f'"libraryfolders"\n{{\n"1" {{ "path" "{library}" }}\n}}\n')
|
||||
older = self.steam / 'steamapps/compatdata/42/pfx/drive_c/users/steamuser'
|
||||
older.mkdir(parents=True)
|
||||
(older / 'save.dat').write_bytes(b'old')
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertEqual(library / 'steamapps/compatdata/42', self.shortcut_prefix().resolve())
|
||||
self.assertEqual(b'cloud', (self.shortcut_prefix() / 'pfx/drive_c/users/steamuser/save.dat').read_bytes())
|
||||
self.assertEqual(b'old', (older / 'save.dat').read_bytes())
|
||||
|
||||
def test_an_existing_shortcut_prefix_is_never_replaced(self):
|
||||
game, library = self.steam_install()
|
||||
(self.steam / 'steamapps').mkdir(parents=True, exist_ok=True)
|
||||
(self.steam / 'steamapps/libraryfolders.vdf').write_text(f'"libraryfolders"\n{{\n"1" {{ "path" "{library}" }}\n}}\n')
|
||||
local = self.shortcut_prefix() / 'pfx/drive_c'
|
||||
local.mkdir(parents=True)
|
||||
(local / 'local.dat').write_bytes(b'local')
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertFalse(self.shortcut_prefix().is_symlink())
|
||||
self.assertEqual(b'local', (local / 'local.dat').read_bytes())
|
||||
self.assertEqual(b'cloud', (library / 'steamapps/compatdata/42/pfx/drive_c/users/steamuser/save.dat').read_bytes())
|
||||
|
||||
def test_shortcuts_without_a_manifest_identity_keep_their_own_prefix(self):
|
||||
game, library = self.steam_install()
|
||||
(self.steam / 'steamapps').mkdir(parents=True, exist_ok=True)
|
||||
(self.steam / 'steamapps/libraryfolders.vdf').write_text(f'"libraryfolders"\n{{\n"1" {{ "path" "{library}" }}\n}}\n')
|
||||
imports.route(self.steam, self.acct, [self.game, dict(game, folder=str(self.folder.parent / 'Other'))])
|
||||
self.assertFalse(os.path.lexists(self.shortcut_prefix()))
|
||||
|
||||
def test_a_manifest_without_a_steam_prefix_links_nothing(self):
|
||||
game, library = self.steam_install()
|
||||
shutil.rmtree(library / 'steamapps/compatdata/42')
|
||||
(self.steam / 'steamapps').mkdir(parents=True, exist_ok=True)
|
||||
(self.steam / 'steamapps/libraryfolders.vdf').write_text(f'"libraryfolders"\n{{\n"1" {{ "path" "{library}" }}\n}}\n')
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertFalse(os.path.lexists(self.shortcut_prefix()))
|
||||
|
||||
def test_an_older_prefix_in_another_library_is_not_linked_for_a_steam_install(self):
|
||||
game, library = self.steam_install()
|
||||
shutil.rmtree(library / 'steamapps/compatdata/42')
|
||||
(self.steam / 'steamapps').mkdir(parents=True, exist_ok=True)
|
||||
(self.steam / 'steamapps/libraryfolders.vdf').write_text(f'"libraryfolders"\n{{\n"1" {{ "path" "{library}" }}\n}}\n')
|
||||
(self.steam / 'steamapps/compatdata/42/pfx/drive_c').mkdir(parents=True)
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertFalse(os.path.lexists(self.shortcut_prefix()))
|
||||
|
||||
def test_a_dangling_shortcut_prefix_link_is_replaced(self):
|
||||
game, library = self.steam_install()
|
||||
self.link_shortcut_prefix(self.root / 'moved')
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertEqual(library / 'steamapps/compatdata/42', self.shortcut_prefix().resolve())
|
||||
|
||||
def test_a_dangling_shortcut_prefix_link_is_removed_without_a_replacement(self):
|
||||
game, library = self.steam_install()
|
||||
shutil.rmtree(library / 'steamapps/compatdata/42')
|
||||
self.link_shortcut_prefix(self.root / 'moved')
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertFalse(os.path.lexists(self.shortcut_prefix()))
|
||||
|
||||
def test_a_link_the_user_made_is_never_changed(self):
|
||||
game, library = self.steam_install()
|
||||
for target in (self.root / 'moved', library / 'steamapps/compatdata/42', self.folder):
|
||||
if os.path.lexists(self.shortcut_prefix()):
|
||||
self.shortcut_prefix().unlink()
|
||||
self.link_shortcut_prefix(target, owned=False)
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertEqual(str(target), os.readlink(self.shortcut_prefix()))
|
||||
|
||||
def test_a_user_link_to_the_matching_prefix_is_never_recorded_or_removed(self):
|
||||
game, library = self.steam_install()
|
||||
target = library / 'steamapps/compatdata/42'
|
||||
self.link_shortcut_prefix(target, owned=False)
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertEqual(str(target), os.readlink(self.shortcut_prefix()))
|
||||
self.assertNotIn(str(self.shortcut_prefix()), imports.read_json(self.steam / 'steamapps' / imports.PREFIX_LINKS, {}))
|
||||
shutil.rmtree(target)
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertTrue(os.path.islink(self.shortcut_prefix()))
|
||||
self.assertEqual(str(target), os.readlink(self.shortcut_prefix()))
|
||||
|
||||
def test_our_link_survives_a_library_that_is_temporarily_missing(self):
|
||||
game, library = self.steam_install()
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
hidden = self.root / 'Hidden'
|
||||
library.rename(hidden)
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertTrue(os.path.islink(self.shortcut_prefix()))
|
||||
hidden.rename(library)
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertEqual(library / 'steamapps/compatdata/42', self.shortcut_prefix().resolve())
|
||||
self.assertEqual(b'cloud', (self.shortcut_prefix() / 'pfx/drive_c/users/steamuser/save.dat').read_bytes())
|
||||
|
||||
def test_our_link_is_dropped_once_its_prefix_is_deleted(self):
|
||||
game, library = self.steam_install()
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
shutil.rmtree(library / 'steamapps/compatdata/42')
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertFalse(os.path.lexists(self.shortcut_prefix()))
|
||||
self.assertEqual({}, imports.read_json(self.steam / 'steamapps' / imports.PREFIX_LINKS, None))
|
||||
|
||||
def test_a_replaced_link_record_is_forgotten_when_the_user_makes_a_real_prefix(self):
|
||||
game, library = self.steam_install()
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.shortcut_prefix().unlink()
|
||||
(self.shortcut_prefix() / 'pfx/drive_c').mkdir(parents=True)
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertFalse(self.shortcut_prefix().is_symlink())
|
||||
self.assertEqual({}, imports.read_json(self.steam / 'steamapps' / imports.PREFIX_LINKS, None))
|
||||
|
||||
def test_a_shortcut_prefix_with_its_own_saves_is_reported_and_kept(self):
|
||||
game, library = self.steam_install()
|
||||
local = self.shortcut_prefix() / 'pfx/drive_c'
|
||||
local.mkdir(parents=True)
|
||||
with patch('builtins.print') as printed:
|
||||
imports.route(self.steam, self.acct, [game])
|
||||
self.assertTrue(local.is_dir())
|
||||
self.assertIn('keeps its own prefix', printed.call_args_list[-1][0][0])
|
||||
|
||||
def test_a_winnative_game_shares_the_prefix_the_steam_client_uses(self):
|
||||
self.winnative_manifest()
|
||||
(self.steam / 'steamapps/libraryfolders.vdf').parent.mkdir(parents=True, exist_ok=True)
|
||||
saves = self.steam / 'steamapps/compatdata/42/pfx/drive_c/users/steamuser'
|
||||
saves.mkdir(parents=True)
|
||||
(saves / 'save.dat').write_bytes(b'cloud')
|
||||
imports.share_prefix(self.steam, self.game)
|
||||
self.assertEqual(self.steam / 'steamapps/compatdata/42', self.shortcut_prefix().resolve())
|
||||
|
||||
def test_an_unreadable_library_does_not_stop_the_routing(self):
|
||||
with patch.object(Path, 'glob', side_effect=PermissionError):
|
||||
games, routes = imports.route(self.steam, self.acct, [self.game])
|
||||
self.assertEqual([self.game], games)
|
||||
self.assertFalse(os.path.lexists(self.shortcut_prefix()))
|
||||
|
||||
def test_store_installs_stay_shortcuts_even_when_owned_on_steam(self):
|
||||
self.snapshot()
|
||||
game = dict(self.game, store='amazon')
|
||||
|
||||
Reference in new issue
Block a user