Fix crash with older app manifests

Older app manifest files store the name of the application in the
`userconfig/name` field rather than just `name`.

Fixes #103

CHANGELOG.md

@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]
 ### Fixed
  - Custom Proton installations now use Steam Runtime installations when applicable
+ - Fix crash caused by older Steam app installations using a different app manifest structure
 
 ## [1.5.1] - 2021-05-10
 ### Fixed

src/protontricks/steam.py

@@ -187,7 +187,12 @@ def from_appmanifest(cls, path, steam_lib_paths):
         # Use case-insensitive field names to deal with these.
         app_state = lower_dict(app_state)
         appid = int(app_state["appid"])
-        name = app_state["name"]
+
+        try:
+            name = app_state["name"]
+        except KeyError:
+            # Older app installations also use `userconfig/name`
+            name = app_state["userconfig"]["name"]
 
         # Proton prefix may exist on a different library
         prefix_path = find_appid_proton_prefix(

src/protontricks/util.py

@@ -31,12 +31,19 @@ def is_flatpak_sandbox():
 
 def lower_dict(d):
     """
-    Return a copy of the dictionary with all keys converted to lowercase.
+    Return a copy of the dictionary with all keys recursively converted to
+    lowercase.
 
     This is mainly used when dealing with Steam VDF files, as those tend to
     have either CamelCase or lowercase keys depending on the version.
     """
-    return {k.lower(): v for k, v in d.items()}
+    def _lower_value(value):
+        if not isinstance(value, dict):
+            return value
+
+        return {k.lower(): _lower_value(v) for k, v in value.items()}
+
+    return {k.lower(): _lower_value(v) for k, v in d.items()}
 
 
 def get_legacy_runtime_library_paths(legacy_steam_runtime_path, proton_app):

tests/test_steam.py

@@ -4,6 +4,7 @@
 from pathlib import Path
 
 import pytest
+import vdf
 
 from protontricks.steam import (SteamApp, find_appid_proton_prefix,
                                 find_steam_path, find_steam_proton_app,
@@ -102,6 +103,34 @@ def test_steam_app_proton_dist_path(self, default_proton):
         shutil.rmtree(str(default_proton.install_path / "files"))
         assert default_proton.proton_dist_path is None
 
+    def test_steam_app_userconfig_name(self, steam_app_factory):
+        """
+        Try creating a SteamApp from an older version of the app manifest
+        which contains the application name in a different field
+
+        See GitHub issue #103 for details
+        """
+        steam_app = steam_app_factory(name="Fake game", appid=10)
+
+        appmanifest_path = \
+            Path(steam_app.install_path).parent.parent / "appmanifest_10.acf"
+        data = vdf.loads(appmanifest_path.read_text())
+
+        # Older installations store the name in `userconfig/name` instead
+        del data["AppState"]["name"]
+        data["AppState"]["userconfig"] = {
+            "name": "Fake game"
+        }
+
+        appmanifest_path.write_text(vdf.dumps(data))
+
+        app = SteamApp.from_appmanifest(
+            path=appmanifest_path,
+            steam_lib_paths=[]
+        )
+
+        assert app.name == "Fake game"
+
 
 class TestFindSteamProtonApp:
     def test_find_steam_specific_app_proton(

tests/test_util.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from protontricks.util import create_wine_bin_dir, run_command
+from protontricks.util import create_wine_bin_dir, run_command, lower_dict
 
 
 def get_files_in_dir(d):
@@ -123,3 +123,31 @@ def test_unknown_steam_runtime_detected(
         )
         assert warning.getMessage() == \
             "Current Steam Runtime not recognized by Protontricks."
+
+
+class TestLowerDict:
+    def test_lower_nested_dict(self):
+        """
+        Turn all keys in a nested dictionary to lowercase using `lower_dict`
+        """
+        before = {
+            "AppState": {
+                "Name": "Blah",
+                "appid": 123450,
+                "userconfig": {
+                    "Language": "English"
+                }
+            }
+        }
+
+        after = {
+            "appstate": {
+                "name": "Blah",
+                "appid": 123450,
+                "userconfig": {
+                    "language": "English"
+                }
+            }
+        }
+
+        assert lower_dict(before) == after