v2.0.3

Migrate old windows data location to the current one

.github/workflows/ci.yml

@@ -51,10 +51,10 @@ jobs:
           timeout 2 cartridges; [ "$?" -eq "124" ]
 
       - name: Inno Setup
-        run: iscc ".\_build\Cartridges.iss"
+        run: iscc ".\_build\windows\Cartridges.iss"
 
       - name: Upload Artifact
         uses: actions/upload-artifact@v3
         with:
           name: Windows Installer
-          path: _build/Output/Cartridges Setup.exe
+          path: _build/windows/Output/Cartridges Setup.exe

data/hu.kramo.Cartridges.gschema.xml.in

@@ -14,7 +14,7 @@
       <default>true</default>
     </key>
     <key name="steam-location" type="s">
-      <default>"~/.steam/"</default>
+      <default>"~/.steam/steam"</default>
     </key>
     <key name="lutris" type="b">
       <default>true</default>

data/hu.kramo.Cartridges.metainfo.xml.in

@@ -44,6 +44,13 @@
   </screenshots>
   <content_rating type="oars-1.1" />
   <releases>
+    <release version="2.0.3" date="2023-07-08">
+      <description translatable="no">
+        <ul>
+          <li>Fixes an issue with Windows data storage</li>
+        </ul>
+      </description>
+    </release>
     <release version="2.0" date="2023-07-05">
       <description translatable="no">
         <p>After months of work, Cartridges 2.0 is here:</p>

docs/game_id.json.md

@@ -49,9 +49,9 @@ Stored as a string.
 
 ### source
 
-A unique ID for the source of the game in lowercase, without spaces.
+A unique ID for the source of the game in lowercase, without spaces or underscores.
 
-If a source provides multiple internal sources, these should be separately labeled, but share a common prefix. eg. `heoic_gog`, `heroic_epic`.
+If a source provides multiple internal sources, these should be separately labeled, but share a common prefix. eg. `heoic_gog`, `heroic_epic`. This is the only place you should use an underscore.
 
 Stored as a string.
 

flatpak/hu.kramo.Cartridges.Devel.json

@@ -28,8 +28,7 @@
         "/share/man",
         "/share/pkgconfig",
         "*.la",
-        "*.a",
+        "*.a"
-        "Cartridges.iss"
     ],
     "modules" : [
         {

meson.build

@@ -1,5 +1,5 @@
 project('cartridges',
-          version: '2.0',
+          version: '2.0.3',
     meson_version: '>= 0.59.0',
   default_options: [ 'warning_level=2', 'werror=false', ],
 )
@@ -33,13 +33,9 @@ subdir('data')
 subdir('src')
 subdir('po')
 
-configure_file(
+if host_machine.system() == 'windows'
-  input: './windows/Cartridges.iss.in',
+  subdir('windows')
-  output: 'Cartridges.iss',
+endif
-  configuration: conf,
-  install: true,
-  install_dir: '.'
-)
 
 gnome.post_install(
      glib_compile_schemas: true,

src/details_window.py

@@ -155,9 +155,10 @@ class DetailsWindow(Adw.Window):
                 return
 
             # Increment the number after the game id (eg. imported_1, imported_2)
+            source_id = "imported"
             numbers = [0]
             game_id: str
-            for game_id in shared.store.games:
+            for game_id in shared.source_games[source_id]:
                 prefix = "imported_"
                 if not game_id.startswith(prefix):
                     continue
@@ -168,7 +169,7 @@ class DetailsWindow(Adw.Window):
                 {
                     "game_id": f"imported_{game_number}",
                     "hidden": False,
-                    "source": "imported",
+                    "source": source_id,
                     "added": int(time()),
                 }
             )

src/importer/importer.py

@@ -91,6 +91,8 @@ class Importer(ErrorProducer):
     def run(self):
         """Use several Gio.Task to import games from added sources"""
 
+        shared.win.get_application().lookup_action("import").set_enabled(False)
+
         self.create_dialog()
 
         # Collect all errors and reset the cancellables for the managers
@@ -221,6 +223,7 @@ class Importer(ErrorProducer):
         self.import_dialog.close()
         self.summary_toast = self.create_summary_toast()
         self.create_error_dialog()
+        shared.win.get_application().lookup_action("import").set_enabled(True)
 
     def create_error_dialog(self):
         """Dialog containing all errors raised by importers"""

src/importer/sources/heroic_source.py

@@ -81,7 +81,7 @@ class HeroicSourceIterator(SourceIterator):
         runner = entry["runner"]
         service = self.sub_sources[runner]["service"]
         values = {
-            "source": self.source.id,
+            "source": f"{self.source.id}_{service}",
             "added": added_time,
             "name": entry["title"],
             "developer": entry.get("developer", None),
@@ -159,4 +159,4 @@ class HeroicSource(URLExecutableSource):
     @property
     def game_id_format(self) -> str:
         """The string format used to construct game IDs"""
-        return self.name.lower() + "_{service}_{game_id}"
+        return self.id + "_{service}_{game_id}"

src/importer/sources/legendary_source.py

@@ -92,7 +92,7 @@ class LegendarySourceIterator(SourceIterator):
 class LegendarySource(Source):
     name = "Legendary"
     executable_format = "legendary launch {app_name}"
-    available_on = {"linux", "win32"}
+    available_on = {"linux"}
 
     iterator_class = LegendarySourceIterator
     config_location: Location = Location(

src/importer/sources/steam_source.py

@@ -118,9 +118,9 @@ class SteamSource(URLExecutableSource):
     data_location = Location(
         schema_key="steam-location",
         candidates=(
-            shared.flatpak_dir / "com.valvesoftware.Steam" / "data" / "Steam",
+            shared.home / ".steam" / "steam",
             shared.data_dir / "Steam",
-            shared.home / ".steam",
+            shared.flatpak_dir / "com.valvesoftware.Steam" / "data" / "Steam",
             shared.programfiles32_dir / "Steam",
         ),
         paths={

src/main.py

@@ -19,6 +19,7 @@
 
 import json
 import lzma
+import os
 import sys
 
 import gi
@@ -49,6 +50,7 @@ from src.store.managers.online_cover_manager import OnlineCoverManager
 from src.store.managers.sgdb_manager import SGDBManager
 from src.store.managers.steam_api_manager import SteamAPIManager
 from src.store.store import Store
+from src.utils.migrate_files_v1_to_v2 import migrate_files_v1_to_v2
 from src.window import CartridgesWindow
 
 
@@ -64,6 +66,12 @@ class CartridgesApplication(Adw.Application):
     def do_activate(self):  # pylint: disable=arguments-differ
         """Called on app creation"""
 
+        setup_logging()
+        log_system_info()
+
+        if os.name == "nt":
+            migrate_files_v1_to_v2()
+
         # Set fallback icon-name
         Gtk.Window.set_default_icon_name(shared.APP_ID)
 
@@ -93,7 +101,7 @@ class CartridgesApplication(Adw.Application):
         shared.store.add_manager(SteamAPIManager())
         shared.store.add_manager(OnlineCoverManager())
         shared.store.add_manager(SGDBManager())
-        shared.store.enable_manager_in_pipelines(FileManager)
+        shared.store.toggle_manager_in_pipelines(FileManager, True)
 
         # Create actions
         self.create_actions(
@@ -179,6 +187,7 @@ class CartridgesApplication(Adw.Application):
             # Translators: Replace this with your name for it to show up in the about window
             translator_credits=_("translator_credits"),
             debug_info=debug_str,
+            debug_info_filename="cartridges.log",
         )
         about.present()
 
@@ -278,7 +287,5 @@ class CartridgesApplication(Adw.Application):
 
 def main(_version):
     """App entry point"""
-    setup_logging()
-    log_system_info()
     app = CartridgesApplication()
     return app.run(sys.argv)

src/preferences.py

@@ -214,10 +214,9 @@ class PreferencesWindow(Adw.PreferencesWindow):
         self.toast.dismiss()
 
     def remove_all_games(self, *_args):
-        for game in shared.store.games.values():
+        for game in shared.store:
             if not game.removed:
                 self.removed_games.add(game)
-
                 game.removed = True
                 game.save()
                 game.update()

src/shared.py.in

@@ -34,7 +34,7 @@ state_schema = Gio.Settings.new(APP_ID + ".State")
 home = Path.home()
 data_dir = Path(GLib.get_user_data_dir())
 config_dir = Path(GLib.get_user_config_dir())
-cache_dir = Path(GLib.get_user_config_dir())
+cache_dir = Path(GLib.get_user_cache_dir())
 flatpak_dir = home / ".var" / "app"
 
 games_dir = data_dir / "cartridges" / "games"

src/store/store.py

@@ -18,6 +18,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 import logging
+from typing import MutableMapping, Generator, Any
 
 from src import shared
 from src.game import Game
@@ -31,24 +32,59 @@ class Store:
     managers: dict[type[Manager], Manager]
     pipeline_managers: set[Manager]
     pipelines: dict[str, Pipeline]
-    games: dict[str, Game]
+    source_games: MutableMapping[str, MutableMapping[str, Game]]
 
     def __init__(self) -> None:
         self.managers = {}
         self.pipeline_managers = set()
         self.pipelines = {}
-        self.games = {}
+        self.source_games = {}
+
+    def __contains__(self, obj: object) -> bool:
+        """Check if the game is present in the store with the `in` keyword"""
+        if not isinstance(obj, Game):
+            return False
+        if not (source_mapping := self.source_games.get(obj.source)):
+            return False
+        return obj.game_id in source_mapping
+
+    def __iter__(self) -> Generator[Game, None, None]:
+        """Iterate through the games in the store with `for ... in`"""
+        for _source_id, games_mapping in self.source_games.items():
+            for _game_id, game in games_mapping.items():
+                yield game
+
+    def __len__(self) -> int:
+        """Get the number of games in the store with the `len` builtin"""
+        return sum(len(source_mapping) for source_mapping in self.source_games)
+
+    def __getitem__(self, game_id: str) -> Game:
+        """Get a game by its id with `store["game_id_goes_here"]`"""
+        for game in iter(self):
+            if game.game_id == game_id:
+                return game
+        raise KeyError("Game not found in store")
+
+    def get(self, game_id: str, default: Any = None) -> Game | Any:
+        """Get a game by its ID, with a fallback if not found"""
+        try:
+            game = self[game_id]
+            return game
+        except KeyError:
+            return default
 
     def add_manager(self, manager: Manager, in_pipeline=True):
         """Add a manager to the store"""
         manager_type = type(manager)
         self.managers[manager_type] = manager
-        if in_pipeline:
+        self.toggle_manager_in_pipelines(manager_type, in_pipeline)
-            self.enable_manager_in_pipelines(manager_type)
 
-    def enable_manager_in_pipelines(self, manager_type: type[Manager]):
+    def toggle_manager_in_pipelines(self, manager_type: type[Manager], enable: bool):
-        """Make a manager run in new pipelines"""
+        """Change if a manager should run in new pipelines"""
-        self.pipeline_managers.add(self.managers[manager_type])
+        if enable:
+            self.pipeline_managers.add(self.managers[manager_type])
+        else:
+            self.pipeline_managers.discard(self.managers[manager_type])
 
     def cleanup_game(self, game: Game) -> None:
         """Remove a game's files"""
@@ -74,7 +110,7 @@ class Store:
             return None
 
         # Handle game duplicates
-        stored_game = self.games.get(game.game_id)
+        stored_game = self.get(game.game_id)
         if not stored_game:
             # New game, do as normal
             logging.debug("New store game %s (%s)", game.name, game.game_id)
@@ -96,11 +132,15 @@ class Store:
             for signal in manager.signals:
                 game.connect(signal, manager.execute_resilient_manager_logic)
 
+        # Add the game to the store
+        if not game.source in self.source_games:
+            self.source_games[game.source] = {}
+        self.source_games[game.source][game.game_id] = game
+
         # Run the pipeline for the game
         if not run_pipeline:
             return None
         pipeline = Pipeline(game, additional_data, self.pipeline_managers)
-        self.games[game.game_id] = game
         self.pipelines[game.game_id] = pipeline
         pipeline.advance()
         return pipeline

src/utils/migrate_files_v1_to_v2.py

@@ -0,0 +1,128 @@
+# migrate_files_v1_to_v2.py
+#
+# Copyright 2023 Geoffrey Coulaud
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import json
+import logging
+from pathlib import Path
+
+from src import shared
+
+old_data_dir = Path.home() / ".local" / "share"
+old_cartridges_data_dir = old_data_dir / "cartridges"
+migrated_file_path = old_cartridges_data_dir / ".migrated"
+old_games_dir = old_cartridges_data_dir / "games"
+old_covers_dir = old_cartridges_data_dir / "covers"
+
+
+def migrate_game_covers(game_path: Path):
+    """Migrate a game covers from a source game path to the current dir"""
+    for suffix in (".tiff", ".gif"):
+        cover_path = old_covers_dir / game_path.with_suffix(suffix).name
+        if not cover_path.is_file():
+            continue
+        destination_cover_path = shared.covers_dir / cover_path.name
+        logging.info("Moving %s -> %s", str(cover_path), str(destination_cover_path))
+        cover_path.rename(destination_cover_path)
+
+
+def migrate_files_v1_to_v2():
+    """
+    Migrate user data from the v1.X locations to the latest location.
+
+    Fix for commit 4a204442b5d8ba2e918f8c2605d72e483bf35efd
+    where the windows directories for data, config and cache changed.
+    """
+
+    # Skip if there is no old dir
+    # Skip if old == current
+    # Skip if already migrated
+    if (
+        not old_data_dir.is_dir()
+        or str(old_data_dir) == str(shared.data_dir)
+        or migrated_file_path.is_file()
+    ):
+        return
+
+    logging.info("Migrating data dir %s", str(old_data_dir))
+
+    # Create the current data dir if needed
+    if not shared.data_dir.is_dir():
+        shared.data_dir.mkdir(parents=True)
+
+    old_game_paths = set(old_games_dir.glob("*.json"))
+    old_imported_game_paths = set(
+        filter(lambda path: path.name.startswith("imported_"), old_game_paths)
+    )
+    old_other_game_paths = old_game_paths - old_imported_game_paths
+
+    # Discover current imported games
+    imported_game_number = 0
+    imported_execs = set()
+    for game_path in shared.games_dir.glob("imported_*.json"):
+        try:
+            game_data = json.load(game_path.open("r"))
+        except (OSError, json.JSONDecodeError):
+            continue
+        number = int(game_data["game_id"].replace("imported_", ""))
+        imported_game_number = max(number, imported_game_number)
+        imported_execs.add(game_data["executable"])
+
+    # Migrate imported game files
+    for game_path in old_imported_game_paths:
+        try:
+            game_data = json.load(game_path.open("r"))
+        except (OSError, json.JSONDecodeError):
+            continue
+
+        # Don't migrate if there's a game with the same exec
+        if game_data["executable"] in imported_execs:
+            continue
+
+        # Migrate with updated index
+        imported_game_number += 1
+        game_id = f"imported_{imported_game_number}"
+        game_data["game_id"] = game_id
+        destination_game_path = shared.games_dir / f"{game_id}.json"
+        logging.info(
+            "Moving (updated id) %s -> %s", str(game_path), str(destination_game_path)
+        )
+        json.dump(
+            game_data,
+            destination_game_path.open("w"),
+            indent=4,
+            sort_keys=True,
+        )
+        game_path.unlink()
+        migrate_game_covers(game_path)
+
+    # Migrate all other games
+    for game_path in old_other_game_paths:
+        # Do nothing if already in games dir
+        destination_game_path = shared.games_dir / game_path.name
+        if destination_game_path.exists():
+            continue
+
+        # Else, migrate the game
+        logging.info("Moving %s -> %s", str(game_path), str(destination_game_path))
+        game_path.rename(destination_game_path)
+        migrate_game_covers(game_path)
+
+    # Signal that this dir is migrated
+    migrated_file_path.touch()
+    logging.info("Migration done")

src/window.py

@@ -117,7 +117,7 @@ class CartridgesWindow(Adw.ApplicationWindow):
     def set_library_child(self):
         child, hidden_child = self.notice_empty, self.hidden_notice_empty
 
-        for game in shared.store.games.values():
+        for game in shared.store:
             if game.removed or game.blacklisted:
                 continue
             if game.hidden:

windows/Cartridges.iss.in

@@ -15,10 +15,10 @@ AppSupportURL=https://github.com/kra-mo/cartridges/issues
 AppUpdatesURL={#MyAppURL}
 DefaultDirName={autopf64}\{#MyAppName}
 DisableProgramGroupPage=yes
-LicenseFile=..\LICENSE
+LicenseFile=..\..\LICENSE
 PrivilegesRequiredOverridesAllowed=dialog
 OutputBaseFilename=Cartridges Setup
-SetupIconFile=..\windows\icon.ico
+SetupIconFile=..\..\windows\icon.ico
 Compression=lzma
 SolidCompression=yes
 WizardStyle=modern
@@ -50,7 +50,7 @@ Source: "D:\a\_temp\msys64\ucrt64\share\glib-2.0\*"; DestDir: "{app}\share\glib-
 Source: "D:\a\_temp\msys64\ucrt64\share\gtk-4.0\*"; DestDir: "{app}\share\gtk-4.0"; Flags: recursesubdirs ignoreversion
 Source: "D:\a\_temp\msys64\ucrt64\share\locale\*"; DestDir: "{app}\share\locale"; Flags: recursesubdirs ignoreversion
 
-Source: "..\windows\icon.ico"; DestDir: "{app}"; Flags: recursesubdirs ignoreversion
+Source: "..\..\windows\icon.ico"; DestDir: "{app}"; Flags: recursesubdirs ignoreversion
 
 [Icons]
 Name: "{autoprograms}\{#MyAppName}"; Filename: "{app}\bin\{#MyAppExeName}"; Parameters: """{app}\bin\cartridges"""; IconFilename: "{app}\icon.ico"

windows/meson.build

@@ -0,0 +1,7 @@
+configure_file(
+  input: './Cartridges.iss.in',
+  output: 'Cartridges.iss',
+  configuration: conf,
+  install: true,
+  install_dir: '.'
+)