Refactored registry.py and renamed get_registry_values to get_installed_steam_games. Also improved error handling in there.

Author: AmineI

resources/main.py

@@ -61,11 +61,7 @@ def installed_games():
                       'If this problem persists please contact support.')
         return
 
-    # TODO : Refactor and/or rename get_registry_values, and perhaps return an array of appids instead of a dictionary.
-    #  currently returns a dictionary of string appid as keys, and only values '1'. Uninstalled games in the registry are actually not returned by this function
-    installed_appids_dict = registry.get_registry_values(os.path.join(__addon__.getSetting('steam-path'), 'registry.vdf'))
-    # Get an Array of dictionary keys, ie of the installed games appids. TODO return an array directly from the function above.
-    installed_appids = installed_appids_dict.keys()
+    installed_appids = registry.get_installed_steam_apps(os.path.join(__addon__.getSetting('steam-path'), 'registry.vdf'))
 
     # filter out any applications not listed as installed
     steam_installed_games = filter(lambda app_entry: str(app_entry['appid']) in installed_appids, steam_games_details)

resources/registry.py

@@ -4,15 +4,17 @@
 
 import os
 import xbmc
-from util import log
+from util import *
 
 if os.name == 'nt':
     import _winreg
 
 
 # https://github.com/lutris/lutris/blob/master/lutris/util/steam.py
 def vdf_parse(steam_config_file, config):
-    """Parse a Steam config file and return the contents as a dict."""
+    """Parse a Steam config file and return the contents as a dict with lowercase keys.
+    The motivation behind returning lowercase keys is that the case is not consistent between environments it seems.
+    """
     line = " "
     while line:
         try:
@@ -30,54 +32,68 @@ def vdf_parse(steam_config_file, config):
 
         line_elements = line.strip().split("\"")
         if len(line_elements) == 3:
-            key = line_elements[1]
+            key = line_elements[1].lower()
             steam_config_file.readline()  # skip '{'
             config[key] = vdf_parse(steam_config_file, {})
         else:
             try:
-                config[line_elements[1]] = line_elements[3]
+                config[line_elements[1].lower()] = line_elements[3]
             except IndexError:
                 log('Malformed config file: {}'.format(line), xbmc.LOGERROR)
     return config
 
 
-def is_installed(app_id):
-    app = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER, "Software\\Valve\\Steam\\Apps\\" + app_id)
+def is_installed_win(app_id):
+    """
+    Gets whether an app with the given app id is installed, on Windows
+    :param app_id: app_id to check
+    :return: True if the app is installed, false otherwise
+    """
     try:
-        i = 0
-        while 1:
+        app = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER, "Software\\Valve\\Steam\\Apps\\" + app_id)
+        print(_winreg.QueryInfoKey(app)[1])
+        for i in range(_winreg.QueryInfoKey(app)[1]):
             name, value, type = _winreg.EnumValue(app, i)
             if name == "Installed":
-                return value
-            i += 1
+                return value == 1
+
     except WindowsError:
-        return None
+        pass
+    # Sometimes the key "Installed" does not exist, and we get out of the loop without returning anything,so we return False at the end of the function
+    return False
 
 
-def get_registry_values(registry_path):
-    app_dict = {}
+def get_installed_steam_apps(registry_path):
+    """
+    Obtains the steam games/apps installed on the computer.
+    :param registry_path: Path to the registry.vdf file
+    :return: an array of appids that are installed.
+    """
+    installed_apps = []
 
     if os.name == 'nt':
-        apps = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER, "Software\\Valve\\Steam\\Apps")
         try:
-            i = 0
-            while True:
+            apps = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER, "Software\\Valve\\Steam\\Apps")
+            print(_winreg.QueryInfoKey(apps)[0])
+            for i in range(_winreg.QueryInfoKey(apps)[0]):
                 app_id = _winreg.EnumKey(apps, i)
-                # print(app_id)
-                installed = is_installed(app_id)
-                i += 1
-                if installed:
-                    app_dict[app_id] = installed
+                if is_installed_win(app_id):
+                    installed_apps.append(app_id)
 
-        except WindowsError:
+        except WindowsError as e:
+            show_error(e, "Error while reading Windows registry")
             pass
     else:
         with open(registry_path, 'r') as file:
-            vdf = vdf_parse(file, {})
-            apps = vdf['Registry']['HKCU']['Software']['Valve']['Steam']['Apps']
+            try:
+                vdf = vdf_parse(file, {})
+                apps = vdf['registry']['hkcu']['software']['valve']['steam']['apps']
 
-            # apparently case of 'installed' differs depending on ... ?
-            # i'm sure if i were a python programmer this would look nicer
-            app_dict = dict((k, v) for (k, v) in apps.iteritems() if ({k.lower(): v for k, v in v.items()}.get('installed', '0') == '1'))
+                # apparently case of 'installed' differs depending on ... ?
+                # We create a list of the apps that have a "installed" key equal to "1".
+                installed_apps = [appid for (appid, information) in apps.items() if (information.get('installed', '0') == '1')]
+            except KeyError as e:
+                show_error(e, "Error finding the values from registry.vdf")
+                pass
 
-    return app_dict
+    return installed_apps