Basic support for Desktop Entry source

src/importer/sources/desktop_source.py

@@ -0,0 +1,169 @@
+# desktop_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 shlex
+from pathlib import Path
+from time import time
+from typing import NamedTuple
+
+from gi.repository import GLib, Gtk
+
+from src import shared
+from src.game import Game
+from src.importer.sources.source import ExecutableFormatSource, SourceIterable
+
+
+class DesktopSourceIterable(SourceIterable):
+    source: "DesktopSource"
+
+    def __iter__(self):
+        """Generator method producing games"""
+
+        added_time = int(time())
+
+        icon_theme = Gtk.IconTheme.new()
+
+        search_paths = GLib.get_system_data_dirs() + [
+            "/run/host/usr/share",
+            "/run/host/usr/local/share",
+            shared.home / ".local" / "share",
+        ]
+
+        for search_path in search_paths:
+            if not (path := Path(search_path) / "icons").exists():
+                continue
+
+            if str(path).startswith("/app/"):
+                continue
+
+            icon_theme.add_search_path(str(path))
+
+        match shared.schema.get_enum("desktop-terminal"):
+            case 0:
+                terminal_exec = shared.schema.get_string("desktop-terminal-custom-exec")
+            case 1:
+                terminal_exec = "xdg-terminal-exec"
+            case 2:
+                terminal_exec = "kgx -e"
+            case 3:
+                terminal_exec = "gnome-terminal --"
+            case 4:
+                terminal_exec = "konsole -e"
+            case 5:
+                terminal_exec = "xterm -e"
+        terminal_exec += " "
+
+        for path in search_paths:
+            if str(path).startswith("/app/"):
+                continue
+
+            path = Path(path) / "applications"
+
+            if not path.is_dir():
+                continue
+
+            for entry in path.iterdir():
+                if entry.suffix != ".desktop":
+                    continue
+
+                keyfile = GLib.KeyFile.new()
+
+                try:
+                    keyfile.load_from_file(str(entry), 0)
+
+                    if "Game" not in keyfile.get_string_list(
+                        "Desktop Entry", "Categories"
+                    ):
+                        continue
+
+                    name = keyfile.get_string("Desktop Entry", "Name")
+                    executable = keyfile.get_string("Desktop Entry", "Exec")
+                except GLib.GError:
+                    continue
+
+                try:
+                    terminal = keyfile.get_boolean("Desktop Entry", "Terminal")
+                except GLib.GError:
+                    terminal = False
+
+                try:
+                    cd_path = (
+                        "cd " + keyfile.get_string("Desktop Entry", "Path") + " && "
+                    )
+                except GLib.GError:
+                    cd_path = ""
+
+                values = {
+                    "source": self.source.source_id,
+                    "added": added_time,
+                    "name": name,
+                    "game_id": "desktop" + executable.replace(" ", "_"),
+                    "executable": self.source.executable_format.format(
+                        exec=cd_path
+                        + (
+                            (terminal_exec + shlex.quote(executable))
+                            if terminal
+                            else executable
+                        )
+                    ),
+                }
+                game = Game(values)
+
+                additional_data = {}
+
+                try:
+                    if (
+                        icon_path := icon_theme.lookup_icon(
+                            keyfile.get_string("Desktop Entry", "Icon"),
+                            None,
+                            512,
+                            1,
+                            shared.win.get_direction(),
+                            0,
+                        )
+                        .get_file()
+                        .get_path()
+                    ):
+                        additional_data = {"local_icon_path": Path(icon_path)}
+                    else:
+                        pass
+                except GLib.GError:
+                    pass
+
+                yield (game, additional_data)
+
+
+class DesktopLocations(NamedTuple):
+    pass
+
+
+class DesktopSource(ExecutableFormatSource):
+    """Generic Flatpak source"""
+
+    source_id = "desktop"
+    name = _("Desktop")
+    iterable_class = DesktopSourceIterable
+    executable_format = "{exec}"
+    available_on = {"linux"}
+
+    locations: DesktopLocations
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.locations = DesktopLocations()