3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/pkgs/tools/package-management/protontricks/steam-run.patch

356 lines
14 KiB
Diff
Raw Normal View History

2021-09-06 15:37:35 +01:00
diff --git a/src/protontricks/cli/main.py b/src/protontricks/cli/main.py
2021-10-26 05:09:44 +01:00
index d811cb7..a376a34 100755
2021-09-06 15:37:35 +01:00
--- a/src/protontricks/cli/main.py
+++ b/src/protontricks/cli/main.py
@@ -14,8 +14,8 @@ import sys
from .. import __version__
from ..gui import select_steam_app_with_gui
-from ..steam import (find_legacy_steam_runtime_path, find_proton_app,
- find_steam_path, get_steam_apps, get_steam_lib_paths)
+from ..steam import (find_proton_app, find_steam_path, get_steam_apps,
+ get_steam_lib_paths)
from ..util import is_flatpak_sandbox, run_command
from ..winetricks import get_winetricks_path
from .util import (CustomArgumentParser, cli_error_handler, enable_logging,
@@ -60,8 +60,7 @@ def main(args=None):
"WINE: path to a custom 'wine' executable\n"
"WINESERVER: path to a custom 'wineserver' executable\n"
"STEAM_RUNTIME: 1 = enable Steam Runtime, 0 = disable Steam "
- "Runtime, valid path = custom Steam Runtime path, "
2021-09-06 15:37:35 +01:00
- "empty = enable automatically (default)\n"
+ "Runtime, empty = enable automatically (default)\n"
"PROTONTRICKS_GUI: GUI provider to use, accepts either 'yad' "
"or 'zenity'"
),
2021-09-06 15:37:35 +01:00
@@ -147,17 +146,9 @@ def main(args=None):
if not steam_path:
exit_("Steam installation directory could not be found.")
- # 2. Find the pre-installed legacy Steam Runtime if enabled
- legacy_steam_runtime_path = None
- use_steam_runtime = True
-
+ # 2. Use Steam Runtime if enabled
if os.environ.get("STEAM_RUNTIME", "") != "0" and not args.no_runtime:
- legacy_steam_runtime_path = find_legacy_steam_runtime_path(
- steam_root=steam_root
- )
-
- if not legacy_steam_runtime_path:
2021-09-06 15:37:35 +01:00
- exit_("Steam Runtime was enabled but couldn't be found!")
+ use_steam_runtime = True
else:
use_steam_runtime = False
logger.info("Steam Runtime disabled.")
2021-09-06 15:37:35 +01:00
@@ -218,7 +209,6 @@ def main(args=None):
proton_app=proton_app,
steam_app=steam_app,
use_steam_runtime=use_steam_runtime,
- legacy_steam_runtime_path=legacy_steam_runtime_path,
2021-10-26 05:09:44 +01:00
command=[str(winetricks_path), "--gui"],
use_bwrap=use_bwrap
)
2021-09-06 15:37:35 +01:00
@@ -286,7 +276,6 @@ def main(args=None):
proton_app=proton_app,
steam_app=steam_app,
use_steam_runtime=use_steam_runtime,
- legacy_steam_runtime_path=legacy_steam_runtime_path,
use_bwrap=use_bwrap,
2021-10-26 05:09:44 +01:00
command=[str(winetricks_path)] + args.winetricks_command)
elif args.command:
2021-09-06 15:37:35 +01:00
@@ -296,7 +285,6 @@ def main(args=None):
steam_app=steam_app,
command=args.command,
use_steam_runtime=use_steam_runtime,
- legacy_steam_runtime_path=legacy_steam_runtime_path,
use_bwrap=use_bwrap,
# Pass the command directly into the shell *without*
# escaping it
diff --git a/src/protontricks/steam.py b/src/protontricks/steam.py
2021-10-26 05:09:44 +01:00
index be5322b..552f894 100644
--- a/src/protontricks/steam.py
+++ b/src/protontricks/steam.py
2021-10-26 05:09:44 +01:00
@@ -12,8 +12,8 @@ from .util import lower_dict, is_flatpak_sandbox
2021-05-10 21:43:41 +01:00
__all__ = (
"COMMON_STEAM_DIRS", "SteamApp", "find_steam_path",
2021-05-10 21:43:41 +01:00
- "find_legacy_steam_runtime_path", "get_appinfo_sections",
2021-09-06 15:37:35 +01:00
- "get_tool_appid", "find_steam_compat_tool_app", "find_appid_proton_prefix",
+ "get_appinfo_sections", "get_tool_appid",
+ "find_steam_compat_tool_app", "find_appid_proton_prefix",
2021-05-10 21:43:41 +01:00
"find_proton_app", "get_steam_lib_paths", "get_compat_tool_dirs",
2021-09-06 15:37:35 +01:00
"get_custom_compat_tool_installations_in_dir", "get_custom_compat_tool_installations",
2021-05-10 21:43:41 +01:00
"find_current_steamid3", "get_appid_from_shortcut",
2021-10-26 05:09:44 +01:00
@@ -318,37 +318,6 @@ def find_steam_path():
return None, None
-def find_legacy_steam_runtime_path(steam_root):
- """
- Find the legacy Steam Runtime either using the STEAM_RUNTIME env or
- steam_root
- """
- env_steam_runtime = os.environ.get("STEAM_RUNTIME", "")
-
- if env_steam_runtime == "0":
- # User has disabled Steam Runtime
- logger.info("STEAM_RUNTIME is 0. Disabling Steam Runtime.")
- return None
2020-12-12 18:00:56 +00:00
- elif env_steam_runtime and Path(env_steam_runtime).is_dir():
- # User has a custom Steam Runtime
- logger.info(
- "Using custom Steam Runtime at %s", env_steam_runtime)
2020-12-12 18:00:56 +00:00
- return Path(env_steam_runtime)
- elif env_steam_runtime in ["1", ""]:
- # User has enabled Steam Runtime or doesn't have STEAM_RUNTIME set;
- # default to enabled Steam Runtime in either case
2020-12-12 18:00:56 +00:00
- steam_runtime_path = steam_root / "ubuntu12_32" / "steam-runtime"
-
- logger.info(
2020-12-12 18:00:56 +00:00
- "Using default Steam Runtime at %s", str(steam_runtime_path))
- return steam_runtime_path
-
- logger.error(
- "Path in STEAM_RUNTIME doesn't point to a valid Steam Runtime!")
-
- return None
-
-
APPINFO_STRUCT_HEADER = "<4sL"
APPINFO_STRUCT_SECTION = "<LLLLQ20sL"
diff --git a/src/protontricks/util.py b/src/protontricks/util.py
2021-09-06 15:37:35 +01:00
index 5252d6c..f16dfec 100644
--- a/src/protontricks/util.py
+++ b/src/protontricks/util.py
2021-09-06 15:37:35 +01:00
@@ -5,15 +5,14 @@ import shutil
2021-05-10 21:43:41 +01:00
import stat
2021-09-06 15:37:35 +01:00
2021-05-10 21:43:41 +01:00
from pathlib import Path
-from subprocess import check_output, run, PIPE
+from subprocess import run, PIPE
__all__ = (
"SUPPORTED_STEAM_RUNTIMES", "is_flatpak_sandbox", "lower_dict",
- "get_legacy_runtime_library_paths", "get_host_library_paths",
- "RUNTIME_ROOT_GLOB_PATTERNS", "get_runtime_library_paths",
- "WINE_SCRIPT_RUNTIME_V1_TEMPLATE",
- "WINE_SCRIPT_RUNTIME_V2_TEMPLATE",
- "create_wine_bin_dir", "run_command"
+ "get_host_library_paths", "RUNTIME_ROOT_GLOB_PATTERNS",
+ "get_runtime_library_paths", "WINE_SCRIPT_RUNTIME_V1_TEMPLATE",
+ "WINE_SCRIPT_RUNTIME_V2_TEMPLATE", "create_wine_bin_dir",
+ "run_command"
)
logger = logging.getLogger("protontricks")
2021-09-06 15:37:35 +01:00
@@ -47,24 +46,6 @@ def lower_dict(d):
2021-06-19 15:21:47 +01:00
return {k.lower(): _lower_value(v) for k, v in d.items()}
-def get_legacy_runtime_library_paths(legacy_steam_runtime_path, proton_app):
2020-12-12 18:00:56 +00:00
- """
- Get LD_LIBRARY_PATH value to use when running a command using Steam Runtime
2020-12-12 18:00:56 +00:00
- """
- steam_runtime_paths = check_output([
- str(legacy_steam_runtime_path / "run.sh"),
- "--print-steam-runtime-library-paths"
- ])
- steam_runtime_paths = str(steam_runtime_paths, "utf-8")
- # Add Proton installation directory first into LD_LIBRARY_PATH
- # so that libwine.so.1 is picked up correctly (see issue #3)
- return "".join([
- str(proton_app.proton_dist_path / "lib"), os.pathsep,
- str(proton_app.proton_dist_path / "lib64"), os.pathsep,
- steam_runtime_paths
- ])
-
-
def get_host_library_paths():
"""
Get host library paths to use when creating the LD_LIBRARY_PATH environment
2021-09-06 15:37:35 +01:00
@@ -76,7 +57,7 @@ def get_host_library_paths():
# Since that command is unavailable with newer Steam Runtime releases,
# do it ourselves here.
result = run(
- ["/sbin/ldconfig", "-XNv"],
+ ["steam-run", "ldconfig", "-XNv"],
check=True, stdout=PIPE, stderr=PIPE
)
lines = result.stdout.decode("utf-8").split("\n")
2021-09-06 15:37:35 +01:00
@@ -94,7 +75,7 @@ RUNTIME_ROOT_GLOB_PATTERNS = (
)
-def get_runtime_library_paths(proton_app, use_bwrap=True):
+def get_runtime_library_paths(proton_app, proton_app_only=True):
"""
Get LD_LIBRARY_PATH value to use when running a command using Steam Runtime
"""
2021-09-06 15:37:35 +01:00
@@ -117,7 +98,7 @@ def get_runtime_library_paths(proton_app, use_bwrap=True):
)
)
- if use_bwrap:
+ if proton_app_only:
return "".join([
str(proton_app.proton_dist_path / "lib"), os.pathsep,
str(proton_app.proton_dist_path / "lib64"), os.pathsep
2021-09-06 15:37:35 +01:00
@@ -133,14 +114,19 @@ def get_runtime_library_paths(proton_app, use_bwrap=True):
])
-WINE_SCRIPT_RUNTIME_V1_TEMPLATE = (
- "#!/bin/bash\n"
- "# Helper script created by Protontricks to run Wine binaries using Steam Runtime\n"
- "export LD_LIBRARY_PATH=\"$PROTON_LD_LIBRARY_PATH\"\n"
- "exec \"$PROTON_DIST_PATH\"/bin/{name} \"$@\""
-)
+# Add Proton installation directory first into LD_LIBRARY_PATH
+# so that libwine.so.1 is picked up correctly (see issue #3)
+WINE_SCRIPT_RUNTIME_V1_TEMPLATE = """#!/usr/bin/env -S steam-run bash
+# Helper script created by Protontricks to run Wine binaries using Steam Runtime
+export LD_LIBRARY_PATH="$PROTON_LD_LIBRARY_PATH":"$LD_LIBRARY_PATH"
+exec "$PROTON_DIST_PATH"/bin/{name} "$@"
+"""
-WINE_SCRIPT_RUNTIME_V2_TEMPLATE = """#!/bin/bash
+# The run script calls pressure-vessel-unruntime which will unset
+# LD_LIBRARY_PATH defined by steam-run. This will cause Pressure
+# Vessel to segfault, so just call pressure-vessel-wrap directly
+# instead.
+WINE_SCRIPT_RUNTIME_V2_TEMPLATE = """#!/usr/bin/env bash
# Helper script created by Protontricks to run Wine binaries using Steam Runtime
2021-05-10 21:43:41 +01:00
set -o errexit
2021-09-06 15:37:35 +01:00
@@ -208,7 +194,9 @@ if [[ -n "$PROTONTRICKS_INSIDE_STEAM_RUNTIME" ]]; then
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH":"$PROTON_LD_LIBRARY_PATH"
"$PROTON_DIST_PATH"/bin/{name} "$@"
else
2021-05-10 21:43:41 +01:00
- exec "$STEAM_RUNTIME_PATH"/run --share-pid --batch \
+ exec steam-run "$STEAM_RUNTIME_PATH"/pressure-vessel/bin/pressure-vessel-wrap \
+ --variable-dir="${{PRESSURE_VESSEL_VARIABLE_DIR:-$STEAM_RUNTIME_PATH/var}}" \
+ --share-pid --batch \
2021-05-10 21:43:41 +01:00
"${{mount_params[@]}}" -- \
env PROTONTRICKS_INSIDE_STEAM_RUNTIME=1 \
"$PROTONTRICKS_PROXY_SCRIPT_PATH" "$@"
2021-09-06 15:37:35 +01:00
@@ -274,7 +262,6 @@ def create_wine_bin_dir(proton_app, use_bwrap=True):
def run_command(
winetricks_path, proton_app, steam_app, command,
use_steam_runtime=False,
- legacy_steam_runtime_path=None,
use_bwrap=True,
**kwargs):
"""Run an arbitrary command with the correct environment variables
2021-09-06 15:37:35 +01:00
@@ -351,7 +338,7 @@ def run_command(
os.environ["STEAM_RUNTIME_PATH"] = \
str(proton_app.required_tool_app.install_path)
os.environ["PROTON_LD_LIBRARY_PATH"] = \
- get_runtime_library_paths(proton_app, use_bwrap=use_bwrap)
+ get_runtime_library_paths(proton_app, proton_app_only=use_bwrap)
2020-12-12 18:00:56 +00:00
runtime_name = proton_app.required_tool_app.name
logger.info(
2021-09-06 15:37:35 +01:00
@@ -372,11 +359,8 @@ def run_command(
"Current Steam Runtime not recognized by Protontricks."
)
else:
- # Legacy Steam Runtime requires a different LD_LIBRARY_PATH
os.environ["PROTON_LD_LIBRARY_PATH"] = \
- get_legacy_runtime_library_paths(
- legacy_steam_runtime_path, proton_app
- )
+ get_runtime_library_paths(proton_app, proton_app_only=True)
# When Steam Runtime is enabled, create a set of helper scripts
# that load the underlying Proton Wine executables with Steam Runtime
2021-09-06 15:37:35 +01:00
@@ -384,8 +368,6 @@ def run_command(
wine_bin_dir = create_wine_bin_dir(
proton_app=proton_app, use_bwrap=use_bwrap
)
- os.environ["LEGACY_STEAM_RUNTIME_PATH"] = \
- str(legacy_steam_runtime_path)
2020-12-12 18:00:56 +00:00
os.environ["PATH"] = "".join([
str(wine_bin_dir), os.pathsep, os.environ["PATH"]
2021-09-06 15:37:35 +01:00
diff --git a/tests/cli/test_main.py b/tests/cli/test_main.py
2021-10-26 05:09:44 +01:00
index f714f2c..b03fac1 100644
2021-09-06 15:37:35 +01:00
--- a/tests/cli/test_main.py
+++ b/tests/cli/test_main.py
@@ -116,15 +116,10 @@ class TestCLIRun:
2020-12-12 18:00:56 +00:00
assert str(command.args[0]).endswith(".local/bin/winetricks")
assert command.args[1] == "winecfg"
assert command.env["PATH"].startswith(str(wine_bin_dir))
- assert (
- "fake_steam_runtime/lib64" in command.env["PROTON_LD_LIBRARY_PATH"]
- )
assert command.env["WINE"] == str(wine_bin_dir / "wine")
assert command.env["WINELOADER"] == str(wine_bin_dir / "wine")
assert command.env["WINESERVER"] == str(wine_bin_dir / "wineserver")
- assert command.env["LEGACY_STEAM_RUNTIME_PATH"] == \
- str(steam_runtime_dir / "steam-runtime")
assert "STEAM_RUNTIME_PATH" not in command.env
for name in ("wine", "wineserver"):
2021-09-06 15:37:35 +01:00
@@ -165,16 +160,14 @@ class TestCLIRun:
assert command.env["PATH"].startswith(str(wine_bin_dir))
# Compared to the traditional Steam Runtime, PROTON_LD_LIBRARY_PATH
- # will be different
+ # will be the same (it would be different without steam-run.patch)
proton_install_path = Path(proton_app.install_path)
assert command.env["PROTON_LD_LIBRARY_PATH"] == "".join([
str(proton_install_path / "dist" / "lib"), os.pathsep,
str(proton_install_path / "dist" / "lib64"), os.pathsep
])
- # Environment variables for both legacy and new Steam Runtime exist
- assert command.env["LEGACY_STEAM_RUNTIME_PATH"] == \
- str(steam_runtime_dir / "steam-runtime")
+ # Environment variable for new Steam Runtime exists
assert command.env["STEAM_RUNTIME_PATH"] == \
str(steam_runtime_soldier.install_path)
2021-09-06 15:37:35 +01:00
@@ -238,9 +231,7 @@ class TestCLIRun:
str(runtime_root / "lib" / "x86_64-linux-gnu")
]))
2021-05-10 21:43:41 +01:00
- # Environment variables for both legacy and new Steam Runtime exist
- assert command.env["LEGACY_STEAM_RUNTIME_PATH"] == \
- str(steam_runtime_dir / "steam-runtime")
+ # Environment variable for new Steam Runtime exists
assert command.env["STEAM_RUNTIME_PATH"] == \
str(steam_runtime_soldier.install_path)
2021-09-06 15:37:35 +01:00
@@ -335,7 +326,6 @@ class TestCLIRun:
# Also ensure log messages are included in the error message
assert b"Found Steam directory at" in message
- assert b"Using default Steam Runtime" in message
def test_run_gui_provider_not_found(self, cli, home_dir, steam_app_factory):
"""
@@ -349,20 +339,6 @@ class TestCLIRun:
2021-09-06 15:37:35 +01:00
assert "YAD or Zenity is not installed" in result
- def test_run_steam_runtime_not_found(
- self, cli, steam_dir, steam_app_factory):
- """
- Try performing a command with Steam Runtime enabled but no
- available Steam Runtime installation
- """
- steam_app_factory(name="Fake game 1", appid=10)
- result = cli(
- ["10", "winecfg"], env={"STEAM_RUNTIME": "invalid/path"},
- expect_exit=True
- )
-
- assert "Steam Runtime was enabled but couldn't be found" in result
-
def test_run_proton_not_found(self, cli, steam_dir, steam_app_factory):
steam_app_factory(name="Fake game 1", appid=10)
result = cli(["10", "winecfg"], expect_exit=True)