Flatpak source initial work

src/importer/sources/flatpak_source.py

@@ -0,0 +1,94 @@
+# flatpak_source.py
+#
+# Copyright 2022-2023 kramo
+#
+# 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 os
+import re
+from pathlib import Path
+from time import time
+
+from xdg import IconTheme
+
+from src import shared
+from src.game import Game
+from src.importer.sources.location import Location
+from src.importer.sources.source import Source, SourceIterationResult, SourceIterator
+
+
+class FlatpakSourceIterator(SourceIterator):
+    source: "FlatpakSource"
+
+    def generator_builder(self) -> SourceIterationResult:
+        """Generator method producing games"""
+
+        added_time = int(time())
+
+        IconTheme.icondirs.append("/var/lib/flatpak/exports/share/icons")
+
+        for entry in (self.source.data_location["applications"]).iterdir():
+            flatpak_id = entry.stem
+
+            with entry.open("r", encoding="utf-8") as open_file:
+                string = open_file.read()
+
+            desktop_values = {"Name": None, "Icon": None}
+            for key in desktop_values:
+                if regex := re.findall(f"{key}=(.*)\n", string):
+                    desktop_values[key] = regex[0]
+
+            if not desktop_values["Name"]:
+                continue
+
+            values = {
+                "source": self.source.id,
+                "added": added_time,
+                "name": desktop_values["Name"],
+                "game_id": self.source.game_id_format.format(game_id=flatpak_id),
+                "executable": self.source.executable_format.format(
+                    flatpak_id=flatpak_id
+                ),
+            }
+            game = Game(values, allow_side_effects=False)
+
+            additional_data = {}
+            if icon_name := desktop_values["Icon"]:
+                if icon_path := IconTheme.getIconPath(icon_name):
+                    additional_data = {"local_image_path": Path(icon_path)}
+
+            # Produce game
+            yield (game, additional_data)
+
+
+class FlatpakSource(Source):
+    """Generic Flatpak source"""
+
+    name = "Flatpak"
+    iterator_class = FlatpakSourceIterator
+    executable_format = "flatpak run {flatpak_id}"
+    available_on = set(("linux",))
+
+    data_location = Location(
+        schema_key="flatpak-location",
+        candidates=(
+            "/var/lib/flatpak/exports/",
+            shared.data_dir / "flatpak" / "exports",
+        ),
+        paths={
+            "applications": (True, "share/applications"),
+        },
+    )